Skip to content
Snippets Groups Projects
Commit 7f8fda9a authored by selva's avatar selva
Browse files

Edits in bitia documentation

parent 130d977b
No related branches found
No related tags found
1 merge request!8Update Documentation
Pipeline #3818 failed with stages
in 3 minutes and 36 seconds
# BiTIA Installation
BiTIA CLI is the Command Interface tool helpful in getting user inputs with commands and required files, directories etc.
BiTIA CLI is the Command Interface Tool which helps in getting user inputs with commands, directories and required files. It sends tasks to the server, where bitia-runner processes them and generates results.
This submits jobs to the server, which contains bitia-runner that works on the job and produce results
**To work with BiTIA, we need to install bitia-cli and submit jobs to the server**
**To work with BiTIA, we need to install bitia-cli and submit tasks to the server**
## Installing bitia
Installing bitia is very simple, you only need to have [python-pip] installed in your system
BiTIA CLI is available on [PyPi] as [BiTIA].
### Ensure you have a working pip
As a first step, you should check that you have a working Python with pip
installed. This can be done by running the following commands and making
sure that the output looks similar.
Ensure you have a working pip with python installed. You can accomplish this by executing the following commands and confirming that the output looks similar
``` bash
$ python --version
......@@ -24,11 +21,23 @@ If that worked, congratulations! You have a working pip in your environment.
To Install **BiTIA** using pip:
To Install **BiTIA** using pip, run this command:
```
$ python3 -m pip install bitia
```
```{eval-rst}
.. tabs::
.. tab:: Linux
$ python3 -m pip install bitia
.. tab:: MacOS
$ python3 -m pip install bitia
.. tab:: Windows
$ python3 -m pip install bitia
```
[BiTIA]: https://pypi.org/project/bitia/
......
......@@ -2,6 +2,7 @@
BiTIA has two commands to work on it:
- run
- submit
- logs
### Bitia run can be employed in three ways;
......
......@@ -21,11 +21,18 @@ BiTIA is a tool that simplifies the infrastructure required to run complex bioin
BiTIA has two components: **bitia-cli** and **bitita-runner**.
BiTIA CLI is on the clientside and allows clients to submit tasks to the bitia server.
BiTIA runner is on the serverside and operates the given tasks to produce results.
<<<<<<< HEAD
## **bitia-cli**
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-cli**
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.
>>>>>>> c83ee47 (Edits in bitia documentation)
[see some examples]: examples
......
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