Skip to content
Snippets Groups Projects
Commit 40021fe8 authored by selva's avatar selva Committed by dilawar
Browse files

Update docmentation

parent d6fa85d3
No related branches found
No related tags found
1 merge request!11update Documentation
...@@ -58,7 +58,7 @@ exclude_patterns = [] ...@@ -58,7 +58,7 @@ exclude_patterns = []
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"] html_static_path = []
sphinx_tabs_valid_builders = ['linkcheck'] sphinx_tabs_valid_builders = ['linkcheck']
......
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
Welcomme to BiTIA Documentation! Welcomme to BiTIA Documentation!
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 is a tool that simplifies the infrastructure required to run complex bioinformatics pipelines. BiTIA plays well with the existing workflow managements systems such as [snakemake](https://snakemake.readthedocs.io/en/stable/), [gnu-Make](https://www.gnu.org/software/make/), etc.
BiTIA has two components: **bitia-cli** and **bitia-runner**. BiTIA has two components: **bitia-cli** and **bitia-runner**.
BiTIA CLI is on the clientside and allows clients to submit tasks to the bitia server. BiTIA CLI is on the clientside and allows clients to submit tasks to the bitia server.
...@@ -40,71 +40,17 @@ getting_started/Working ...@@ -40,71 +40,17 @@ getting_started/Working
If you want to learn how to use BiTIA and installation, check out the following resources: If you want to learn how to use BiTIA and installation, check out the following resources:
<details > ### **GETTING_STARTED**
<summary><b>REQUIREMENTS</b></summary>
> - Python 3.8+
</details>
<details>
<summary><b>INSTALLATION & CONFIGURATION</b></summary>
To Install BiTIA using pip, run this command:
```{eval-rst}
.. tabs::
.. group-tab:: Unix
.. code-block:: bash
$ python3 -m pip install bitia
.. group-tab:: Windows
.. code-block:: bash
$ python3 -m pip install bitia
```
**Configuration**
TODO: Order of searching configuration file.
```{eval-rst}
.. tabs::
.. group-tab:: Unix
.. code-block:: bash
1. ./bitia.toml
2. ~/.bitia.toml
3. $HOME/.config/bitia.toml
4. /etc/bitia.toml
.. group-tab:: Windows
.. code-block:: bash
1. bitia.toml
2. %APPDATA%\bitia.toml
3. %PROGRAMDATA%\bitia.toml
```
</details>
<details>
<summary><b>GETTING_STARTED</b></summary>
- To Learn about Bio-Informatics pipelines ofs RNA-seq analysis refer - To Learn about Bio-Informatics pipelines ofs RNA-seq analysis refer
[Bioinformatics pipelines](https://docs.gdc.cancer.gov/Data/Bioinformatics_Pipelines/Expression_mRNA_Pipeline/) [Bioinformatics pipelines](https://docs.gdc.cancer.gov/Data/Bioinformatics_Pipelines/Expression_mRNA_Pipeline/)
- To Understand working with BiTIA refer [Working with BiTIA CLI](getting_started/Working.md)
</details>
- **REQUIREMENTS**
- Python 3.8+
- [**INSTALLATION & CONFIGURATION**](getting_started/Installation.md)
- To Understand working with BiTIA refer [Working with BiTIA CLI](getting_started/Working.md)
<!-- <!--
......
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