Skip to content

Commit

Permalink
correct installation doc numbering
Browse files Browse the repository at this point in the history
  • Loading branch information
ygidtu committed Sep 21, 2023
1 parent f0d995f commit 5a1cef4
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion AppImageBuilder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ AppDir:
app_info:
id: org.appimage-crafters.trackplot
name: trackplot
version: 0.3.5
version: 0.3.6
# Set the python executable as entry point
exec: "bin/python3"
# Set the application main script path as argument. Use '$@' to forward CLI parameters
Expand Down
28 changes: 15 additions & 13 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Using trackplot by a command line
## Installation

1. install from PyPi
### Using trackplot by a command line

#### 1. install from PyPi

Before running this command line, please check python (>=3.8) was installed.

Expand All @@ -16,7 +18,7 @@ pip install trackplot

---

2. [AppImage](https://github.com/ygidtu/trackplot/releases) (Linux/WSL x86_64 platform only)
#### 2. [AppImage](https://github.com/ygidtu/trackplot/releases) (Linux/WSL x86_64 platform only)


All the AppImage files were tested on the official pre-built GNU/Linux distributions docker images:
Expand Down Expand Up @@ -47,7 +49,7 @@ chmod +x trackplot-${VERSION}-x86_64.AppImage

---

3. using docker image
#### 3. using docker image

> Known issue: the logging time may have several hours mismatch with your local time, due to timezone settings inner the image.
Expand All @@ -64,7 +66,7 @@ docker run --rm ygidtu/trackplot --help

---

4. install from source code
#### 4. install from source code

Prior to installing the tool from the source code, users should verify their Python version (>=3.8).

Expand All @@ -73,7 +75,7 @@ python --version
# Python 3.10.8
```

4.1 python3 is not available
##### 4.1 python3 is not available

If your Python version does not match the requirements of Trackplot,
users could follow the cmd to install and
Expand Down Expand Up @@ -105,7 +107,7 @@ $PWD/Python-3.10.12/Python-3.10.12/Python/bin/trackplot --help

```

4.2 python3 is available
##### 4.2 python3 is available

```bash
# 1. download the trackplot
Expand All @@ -125,7 +127,7 @@ python main.py --help

---

5. install from bioconda
#### 5. install from bioconda

First make sure your conda is properly installed.

Expand Down Expand Up @@ -161,7 +163,7 @@ trackplot --help

---

6. for `pipenv` or `poetry` users
#### 6. for `pipenv` or `poetry` users

> Install [pipenv](https://pipenv.pypa.io/en/latest/) or [poetry](https://python-poetry.org)
Expand Down Expand Up @@ -194,9 +196,9 @@ poetry shell && python main.py --help
poetry run python main.py --help
```

## Using trackplot by a local webserver
### Using trackplot by a local webserver

1. [AppImage](https://github.com/ygidtu/trackplot/releases) (Linux/WSL x86_64 only)
#### 1. [AppImage](https://github.com/ygidtu/trackplot/releases) (Linux/WSL x86_64 only)

```bash
# example with version v0.3.2, please using your interested version according to your needs
Expand All @@ -214,15 +216,15 @@ chmod +x trackplot-${VERSION}-x86_64.AppImage

---

2. Running using command line
#### 2. Running using command line

```bash
trackplot --start-server --host 127.0.0.1 --port 5000 --plots ./plots
```

---

3. Install from a docker image
#### 3. Install from a docker image

```bash
docker pull ygidtu/trackplot
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "trackplot"
version = "0.3.5"
version = "0.3.6"
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/"
authors = ["ygidtu <[email protected]>"]
license = "BSD-3"
Expand Down
3 changes: 1 addition & 2 deletions trackplot/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import os
from multiprocessing import Pool

import matplotlib.pyplot as plt
from matplotlib import gridspec
from matplotlib.backends.backend_agg import FigureCanvasAgg
from matplotlib.backends.backend_pdf import FigureCanvasPdf
Expand All @@ -30,7 +29,7 @@
faulthandler.enable()


__version__ = "0.3.5"
__version__ = "0.3.6"
__author__ = "ygidtu & Ran Zhou"
__email__ = "[email protected]"

Expand Down
2 changes: 1 addition & 1 deletion web/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "trackplot",
"private": true,
"version": "0.3.5",
"version": "0.3.6",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down

0 comments on commit 5a1cef4

Please sign in to comment.