Skip to content

Latest commit

 

History

History
232 lines (164 loc) · 6.53 KB

installation.md

File metadata and controls

232 lines (164 loc) · 6.53 KB

Installation

Using trackplot by a command line

1. install from PyPi

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

# optional, enable bigWig, bigBed and hicMatrix support
pip install pybigwig hicmatrix

pip install trackplot
# __Note:__ We noticed some pypi mirrors are not syncing some packages we depend on, 
# therefore please try another pypi mirror once you encounter 
# `No local packages or working download links found for xxx`

2. AppImage (Linux/WSL x86_64 platform only)

All the AppImage files were tested on the official pre-built GNU/Linux distributions docker images:

  • Arch: appimagecrafters/tests-env:archlinux-latest
  • Fedora: appimagecrafters/tests-env:fedora-30
  • Debian: appimagecrafters/tests-env:debian-stable
  • Ubuntu: appimagecrafters/tests-env:ubuntu-bionic
  • Centos: appimagecrafters/tests-env:centos-7

Due to the limitation of AppImage technic itself, we only provide AppImage for Linux and Windows subsystem for Linux (x86_64 platform) users. Once you have installation issues and not familiar with docker, please download the AppImage file from our releases.

Once the AppImage file couldn't work properly please open an issue in this repo, and provide us the system platform and full error messages for us to debug.

Notes:

  1. the AppImage will decompress all bundled files before execution, therefore it will a little bit slower than command line tools and source code
  2. please use absolute path instead of relative path.
# example with version v0.3.2, please using your interested version according to your needs
export VERSION=0.3.2
chmod +x trackplot-${VERSION}-x86_64.AppImage
./trackplot-${VERSION}-x86_64.AppImage --help

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.

docker pull ygidtu/trackplot
docker run --rm ygidtu/trackplot --help

# or build docker image from source
git clone https://github.com/ygidtu/trackplot trackplot
cd trackplot
docker build -t ygidtu/docker .
docker run --rm ygidtu/trackplot --help

4. install from source code

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

python --version
# Python 3.10.8
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 more detailed instruction for different system please refer to here.

# If the default Python version does not meet the requirements of Trackplot, 
# users should install an appropriate version. 

# 1. install from source code
#   1.1 Step 1: Download the Source Code 
wget https://www.python.org/ftp/python/3.10.12/Python-3.10.12.tgz
tar -xvzf Python-3.10.12.tgz

#   1.2 Step 2: Build Python
find ./Python-3.10.12/Python -type d | xargs chmod 0755
cd Python-3.10.12
./configure --prefix=$PWD/Python-3.10.12/Python
make
make install

# 2. install trackplot
git clone https://github.com/ygidtu/trackplot trackplot

$PWD/Python-3.10.12/python -m pip install -e trackplot/

# 3. check trackplot
$PWD/Python-3.10.12/Python-3.10.12/Python/bin/trackplot --help
4.2 python3 is available
# 1. download the trackplot
git clone https://github.com/ygidtu/trackplot trackplot
cd trackplot

# 2. install the trackplot and it's requirements to python env
pip install -e .
trackplot --help  # or python main.py --help

# Note: pybigwig hicmatrix were optional, used to enable bigWig, bigBed and hicMatrix support
# Once the installation of pybigwig and hicmatrix fails, and these two formats are not necessary, 
# you still can using trackplot in the following way
pip install -r requirements.txt
python main.py --help

5. install from bioconda

First make sure your conda is properly installed.

# Check if conda has been successfully installed.
conda --version

# if conda is not installed, refer to https://conda.io/projects/conda/en/latest/user-guide/install/download.html

After successful installation

# install trackplot into the default conda env 
conda install -c bioconda -c conda-forge trackplot

# or install trackplot into an isolated environments
conda create -n trackplot -c bioconda -c conda-forge trackplot

# if conda is getting stuck at solving environment', please refer to https://stackoverflow.com/a/66963979

# or install latest trackplot  
git clone https://github.com/ygidtu/trackplot.git trackplot
cd trackplot
conda env update -n trackplot --file environment.yaml

# activate the trackplot environment and execute the command line tool
conda activate trackplot
trackplot --help

6. for uv users

Install uv

git clone https://github.com/ygidtu/trackplot
cd trackplot

# uv
# once facing installation issues, please try to change PyPi mirror
# create virtualenv and install required packages
uv sync

# switch to virtualenv
source .venv/bin/activate  && python main.py --help

# or just run with uv
uv run main.py --help

Using trackplot by a local webserver

1. AppImage (Linux/WSL x86_64 only)

# example with version v0.3.2, please using your interested version according to your needs
export VERSION=0.3.2
gunzip trackplot-${VERSION}-x86_64.AppImage
chmod +x trackplot-${VERSION}-x86_64.AppImage
./trackplot-${VERSION}-x86_64.AppImage --help

# startup webserver
./trackplot-${VERSION}-x86_64.AppImage --start-server --host 127.0.0.1 --port 5000 --plots ./plots

Note: the --plots were required while using appimages

2. Running using command line

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

3. Install from a docker image

docker pull ygidtu/trackplot

# Deploy the server
docker run --name trackplot \
  --rm -v $PWD/example:/data -v $PWD/plots/:/plots -p 5000:5000 ygidtu/trackplot \
  --start-server \
  --host 0.0.0.0 \
  --data /data \
  --plots /plots

-p: public and private port for the server, default:5000(public):5000(private)

  • -v, --volume: mount the working directory to docker container, for example, the $PWD/data could replace by the path to your directory contains all necessary data
  • --user: prevent docker read and write file using root privileges
  • the rest usage please check Command line usage