Skip to content

Commit 5a1cef4

Browse files
committed
correct installation doc numbering
1 parent f0d995f commit 5a1cef4

5 files changed

Lines changed: 19 additions & 18 deletions

File tree

AppImageBuilder.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ AppDir:
1111
app_info:
1212
id: org.appimage-crafters.trackplot
1313
name: trackplot
14-
version: 0.3.5
14+
version: 0.3.6
1515
# Set the python executable as entry point
1616
exec: "bin/python3"
1717
# Set the application main script path as argument. Use '$@' to forward CLI parameters

docs/installation.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
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

57
Before 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

2224
All 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

6971
Prior 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

7880
If your Python version does not match the requirements of Trackplot,
7981
users 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

130132
First 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
194196
poetry 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
220222
trackplot --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
228230
docker pull ygidtu/trackplot

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "trackplot"
3-
version = "0.3.5"
3+
version = "0.3.6"
44
description = "The trackplot is a tool for visualizing various next-generation sequencing (NGS) data, including DNA-seq, RNA-seq, single-cell RNA-seq and full-length sequencing datasets. https://sashimi.readthedocs.io/"
55
authors = ["ygidtu <ygidtu@gmail.com>"]
66
license = "BSD-3"

trackplot/plot.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
import os
1111
from multiprocessing import Pool
1212

13-
import matplotlib.pyplot as plt
1413
from matplotlib import gridspec
1514
from matplotlib.backends.backend_agg import FigureCanvasAgg
1615
from matplotlib.backends.backend_pdf import FigureCanvasPdf
@@ -30,7 +29,7 @@
3029
faulthandler.enable()
3130

3231

33-
__version__ = "0.3.5"
32+
__version__ = "0.3.6"
3433
__author__ = "ygidtu & Ran Zhou"
3534
__email__ = "ygidtu@gmail.com"
3635

web/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "trackplot",
33
"private": true,
4-
"version": "0.3.5",
4+
"version": "0.3.6",
55
"type": "module",
66
"scripts": {
77
"dev": "vite",

0 commit comments

Comments
 (0)