Skip to content
Snippets Groups Projects
Commit 130d977b authored by selva's avatar selva
Browse files

Added tabs for Installation guide

parent b0d75d06
No related branches found
Tags v0.1.2
1 merge request!8Update Documentation
sphinx
myst_parser
sphinx-tabs
\ No newline at end of file
......@@ -35,7 +35,7 @@ release = "0.0.1"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["myst_parser", "sphinx.ext.autodoc"]
extensions = ["myst_parser", "sphinx.ext.autodoc",'sphinx_tabs.tabs']
napoleon_google_docstring = False
......@@ -53,9 +53,17 @@ exclude_patterns = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# html_theme = "furo"
#html_theme = "furo"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
sphinx_tabs_valid_builders = ['linkcheck']
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = True
\ No newline at end of file
......@@ -4,9 +4,6 @@
<p align="center">
<p align="center">
```{image} https://img.shields.io/pypi/v/bitia.svg
......@@ -19,7 +16,6 @@
</p>
<<<<<<< HEAD
BiTIA is a tool that simplifies the infrastructure required to run complex bioinformatics pipelines. BiTIA plays well with the existing pipeline solution such as snakemake.
BiTIA has two components: **bitia-cli** and **bitita-runner**.
......@@ -30,22 +26,6 @@ BiTIA runner is on the serverside and operates the given tasks to produce result
Most users only need the `bitia-cli` tool to submit tasks.
BiTIA CLI creates a zip file of the user input(pipeline) containing a unique hash and ships it to the server.
=======
BiTIA is a tool that simplifies the infrastructure required to run complex bioinformatics pipelines. BiTIA plays well with the existing pipeline solution such as snakement.
BiTIA v1.0 comes with client facing bitia-cli and bitita-runner which manages things at the server end.
BiTIA has two components: bitia-cli and bitia-runner.
- **bitia-cli**
Creates a zip file of the user input(pipeline) containing a unique hash and ships it to the server.
- **bitia-runner**
Runs the following tasks in the server:
- Creates a docker container with the user input
- Runs the pipeline
- Sends log to the user
- Sends link of results(artifacts) to the user
- Interacts with common cache for reading data/reference files
>>>>>>> 72129f2 (Updated Main Page)
[see some examples]: examples
......@@ -64,10 +44,6 @@ getting_started/Working
If you want to learn how to use BiTIA and installation, check out the following resources:
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> 72129f2 (Updated Main Page)
<details >
<summary><b>REQUIREMENTS</b></summary>
......@@ -75,7 +51,6 @@ If you want to learn how to use BiTIA and installation, check out the following
</details>
<details>
<summary><b>INSTALLATION</b></summary>
<<<<<<< HEAD
<<<<<<< HEAD
To Install BiTIA using pip, run this command:
......@@ -127,18 +102,6 @@ If you want to learn how to use BiTIA and installation, check out the following
</details>
<details>
=======
<div class="termy">
```console
$ python3 -m pip install bitia
```
</div>
</details>
<details>
>>>>>>> 72129f2 (Updated Main Page)
<summary><b>GETTING_STARTED</b></summary>
### Bioinformatics Pipelines
......@@ -152,14 +115,7 @@ NGS bioinformatics pipelines are frequently platform specific and may be customi
> Sequence generation (signal processing and base calling) is the process that converts sensor (optical and nonoptical) data from the sequencing platform and identifies the sequence of nucleotides for each of the short fragments of DNA in the sample prepared for analysis. For each nucleotide sequenced in these short fragments (ie, raw reads), a corresponding Phred-like quality score is assigned, which is sequencing platform specific. The read sequences along with the Phred-like quality scores are stored in a FASTQ file, which is a de facto standard for representing biological sequence information
</details>
<<<<<<< HEAD
=======
- [Installation](getting_started/Installation.md)
- [Working with BiTIA](getting_started/Working.md)
>>>>>>> 483a0a9 (Added bitia-cli docs info)
=======
>>>>>>> 72129f2 (Updated Main Page)
<details>
......@@ -193,7 +149,6 @@ NGS bioinformatics pipelines are frequently platform specific and may be customi
#### Usage Examples
<<<<<<< HEAD
<<<<<<< HEAD
- **Running Commands**
```bash
......@@ -205,18 +160,6 @@ The above command will execute
```bash
$ bitia run bitia.main.sh
```
=======
</details>
<!--
```{eval-rst}
.. automodule:: bitia
``` -->
>>>>>>> 72129f2 (Updated Main Page)
</details>
......@@ -226,10 +169,6 @@ $ bitia run bitia.main.sh
<!--
```{eval-rst}
.. automodule:: bitia
<<<<<<< HEAD
``` -->
=======
```
>>>>>>> 483a0a9 (Added bitia-cli docs info)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment