1- ## Using trackplot by a command line
1+ ## Installation
22
3- 1 . install from PyPi
3+ ### Using trackplot by a command line
4+
5+ #### 1. install from PyPi
46
57Before running this command line, please check python (>=3.8) was installed.
68
@@ -16,7 +18,7 @@ pip install trackplot
1618
1719---
1820
19- 2 . [ AppImage] ( https://github.com/ygidtu/trackplot/releases ) (Linux/WSL x86_64 platform only)
21+ #### 2. [ AppImage] ( https://github.com/ygidtu/trackplot/releases ) (Linux/WSL x86_64 platform only)
2022
2123
2224All the AppImage files were tested on the official pre-built GNU/Linux distributions docker images:
@@ -47,7 +49,7 @@ chmod +x trackplot-${VERSION}-x86_64.AppImage
4749
4850---
4951
50- 3 . using docker image
52+ #### 3. using docker image
5153
5254> Known issue: the logging time may have several hours mismatch with your local time, due to timezone settings inner the image.
5355
@@ -64,7 +66,7 @@ docker run --rm ygidtu/trackplot --help
6466
6567---
6668
67- 4 . install from source code
69+ #### 4. install from source code
6870
6971Prior to installing the tool from the source code, users should verify their Python version (>=3.8).
7072
@@ -73,7 +75,7 @@ python --version
7375# Python 3.10.8
7476```
7577
76- 4.1 python3 is not available
78+ ##### 4.1 python3 is not available
7779
7880If your Python version does not match the requirements of Trackplot,
7981users could follow the cmd to install and
@@ -105,7 +107,7 @@ $PWD/Python-3.10.12/Python-3.10.12/Python/bin/trackplot --help
105107
106108```
107109
108- 4.2 python3 is available
110+ ##### 4.2 python3 is available
109111
110112``` bash
111113# 1. download the trackplot
@@ -125,7 +127,7 @@ python main.py --help
125127
126128---
127129
128- 5 . install from bioconda
130+ #### 5. install from bioconda
129131
130132First make sure your conda is properly installed.
131133
@@ -161,7 +163,7 @@ trackplot --help
161163
162164---
163165
164- 6 . for ` pipenv ` or ` poetry ` users
166+ #### 6. for ` pipenv ` or ` poetry ` users
165167
166168> Install [ pipenv] ( https://pipenv.pypa.io/en/latest/ ) or [ poetry] ( https://python-poetry.org )
167169
@@ -194,9 +196,9 @@ poetry shell && python main.py --help
194196poetry run python main.py --help
195197```
196198
197- ## Using trackplot by a local webserver
199+ ### Using trackplot by a local webserver
198200
199- 1 . [ AppImage] ( https://github.com/ygidtu/trackplot/releases ) (Linux/WSL x86_64 only)
201+ #### 1. [ AppImage] ( https://github.com/ygidtu/trackplot/releases ) (Linux/WSL x86_64 only)
200202
201203``` bash
202204# example with version v0.3.2, please using your interested version according to your needs
@@ -214,15 +216,15 @@ chmod +x trackplot-${VERSION}-x86_64.AppImage
214216
215217---
216218
217- 2 . Running using command line
219+ #### 2. Running using command line
218220
219221``` bash
220222trackplot --start-server --host 127.0.0.1 --port 5000 --plots ./plots
221223```
222224
223225---
224226
225- 3 . Install from a docker image
227+ #### 3. Install from a docker image
226228
227229``` bash
228230docker pull ygidtu/trackplot
0 commit comments