Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
B
bitia-cli
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
1
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
bitia
bitia-cli
Commits
3072db8d
Commit
3072db8d
authored
2 years ago
by
selva
Committed by
dilawar
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
UPdate termynal
parent
432ea84c
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!11
update Documentation
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/source/getting_started/Installation.md
+10
-6
10 additions, 6 deletions
docs/source/getting_started/Installation.md
docs/source/getting_started/Working.md
+14
-6
14 additions, 6 deletions
docs/source/getting_started/Working.md
with
24 additions
and
12 deletions
docs/source/getting_started/Installation.md
+
10
−
6
View file @
3072db8d
...
...
@@ -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>
...
...
This diff is collapsed.
Click to expand it.
docs/source/getting_started/Working.md
+
14
−
6
View file @
3072db8d
...
...
@@ -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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment