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

UPdate termynal

parent 432ea84c
No related branches found
No related tags found
1 merge request!11update Documentation
......@@ -7,7 +7,7 @@ BiTIA CLI is available on [PyPi] as [BiTIA].
Installing bitia is very simple, you only need to have [python-pip] installed in your system
<link type="text/css" href="../_static/./css/termynal.css" />
To Install **BiTIA** using pip, run this command:
......@@ -20,18 +20,19 @@ To Install **BiTIA** using pip, run this command:
## Configuration
TODO: Order of searching configuration file.
**_UNIX_**
<div id="termynal" data-termynal>
<span data-ty="input">./bitia.toml</span>
<span data-ty="input">~/.bitia.toml</span>
<span data-ty="input">$HOME/.config/bitia.toml</span>
<span data-ty="input">/etc/bitia.toml</span>
<span data-ty="input"> ./bitia.toml </span>
<span data-ty="input"> ~/.bitia.toml </span>
<span data-ty="input"> $HOME/.config/bitia.toml </span>
<span data-ty="input"> /etc/bitia.toml </span>
</div>
**_WINDOWS_**
......@@ -44,6 +45,9 @@ TODO: Order of searching configuration file.
<script src="../_static/./js/termynal.js" data-termynal-container="#termynal"></script>
......
......@@ -4,17 +4,19 @@ The three commands that are the core of BiTIA's functionality are:
- submit
- logs
<link type="text/css" href="../_static/./css/termynal.css" />
### Bitia run can be employed in following ways:
#### 1. Running commands
<div class='termynal' data-termynal>
<div id="termynal" data-termynal>
<span data-ty="input">bitia run "samtools convert < foo.fa|http://y.com/foo.fa >"</span>
<span data-ty="progress"></span>
</div>
<span data-ty="input">bitia run "samtools convert <foo.fa|http://y.com/foo.fa>"</span>
</div>
The above code will:
- Checks for the input file `foo.fa` in the current working directory
......@@ -30,11 +32,13 @@ The above code will:
#### 2. Running Pipelines
<div class='termynal' data-termynal>
<div id="termynal" data-termynal>
<span data-ty="input">bitia run "samtools convert < foo.fa|http://y.com/foo.fa >"</span>
<span data-ty="progress"></span>
</div>
<span data-ty="input">bitia run pipeline.sh</span>
</div>
for `pipeline.sh`:
```bash
......@@ -56,3 +60,7 @@ The above code will:
- Installing the given commands `fastqc`, `trim_galore`,`hisat2` .
- executing the commands given in the pipeline
- Displays the resulting output to the user console
<script src="../_static/./js/termynal.js" data-termynal-container="#termynal"></script>
\ No newline at end of file
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