INSTALL.md

Home | Installation | Quickstart | Tutorials | Recipes | CLI Reference | Gallery | FAQ | About

< Back to Home | Go to Quickstart >

Installation

gbdraw supports three common ways of working:

Method	Best for	Notes
Hosted web app	Quick plotting with zero install	Runs at gbdraw.app in your browser.
Bioconda	Daily local use and reproducible environments	Recommended for most users.
Source install	Development and testing current repository state	Uses pip install -e ".[dev]".

1. Hosted Web App

If you want the fastest path to a figure, open:

https://gbdraw.app/

The hosted app is served as a static site on Cloudflare Pages behind the gbdraw.app custom domain.

Pyodide and the main browser-side assets used by the hosted app are vendored and self-hosted from the repository, so the web UI does not need to fetch those runtime dependencies from third-party CDNs.

Uploaded genomic data is processed locally in the browser. The hosted deployment also uses Cloudflare Web Analytics for aggregate page-visit and performance metrics.

The same UI can also be launched locally after installation with:

gbdraw gui

2. Bioconda Installation

Bioconda is the recommended local installation path for normal use.

mamba create -n gbdraw -c conda-forge -c bioconda gbdraw
conda activate gbdraw
gbdraw -h

Optional: launch the local GUI:

gbdraw gui

3. Source Installation for Development

Use a source install when you want the current repository state, need to run tests, or plan to contribute.

git clone https://github.com/satoshikawato/gbdraw.git
cd gbdraw
python -m pip install -U pip
python -m pip install -e ".[dev]"

Verify the install:

python -m gbdraw.cli -h
pytest tests/ -v -m "not slow"

Optional: Non-SVG Export Support

SVG export works with the base install. PNG, PDF, EPS, and PS export require CairoSVG:

python -m pip install -e ".[dev,export]"

Depending on your platform, CairoSVG may also require system Cairo/Pango libraries.

Related Commands

gbdraw circular --gbk genome.gb -o output -f svg
gbdraw linear --gbk genome1.gb genome2.gb -b comparison.out -o output -f svg
gbdraw gui

< Back to Home | Go to Quickstart >

Home | Installation | Quickstart | Tutorials | Recipes | CLI Reference | Gallery | FAQ | About