Skip to content

satoshikawato/gbdraw

Repository files navigation

Static Badge Anaconda-Server Badge Anaconda-Server Badge install with bioconda Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Ask DeepWiki

gbdraw

gbdraw

gbdraw is a command-line and browser-based tool for publication-quality genome diagrams. It accepts GenBank/DDBJ flatfiles or GFF3 + FASTA pairs and produces circular or linear plots in SVG, PNG, PDF, EPS, or PS.

Features

  • Circular and linear genome diagrams from annotated sequence files
  • Comparative genomics tracks from BLAST outfmt 6 or 7
  • Browser-based GUI at gbdraw.app and local GUI via gbdraw gui
  • Fine-grained control over colors, labels, legends, and track layout
  • SVG-first workflow with optional CairoSVG-based export to PNG, PDF, EPS, and PS

Documentation

Guide Description
Full documentation Main entry point for the published docs set.
Installation Hosted app, Bioconda, and local development installation.
Quickstart First circular plot in a few minutes.
Tutorials Step-by-step guides for styling, comparisons, and advanced customization.
Recipes Copy-paste command patterns for common tasks.
CLI Reference Current command help for the CLI.
Gallery Example plots and commands.
FAQ Common questions and known limitations.
About Citation information and project background.

Use Without Local Installation

The hosted web app runs entirely in your browser:

https://gbdraw.app/

Your data stays on your machine, and no build step or Streamlit install is required.

Local Installation

For regular use, Bioconda is the main installation path:

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

For development from source:

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

If you need PNG/PDF/EPS/PS export from a source install, add the optional export dependency:

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

See Installation for details and platform notes.

Bug Reports and Suggestions

Please open an issue if you find a bug or want to propose an improvement:

https://github.com/satoshikawato/gbdraw/issues

How to cite

If you use gbdraw in your research, please cite the preprint:

Kawato, S. (2026). gbdraw: a genome diagram generator for microbes and organelles. bioRxiv. https://doi.org/10.64898/2026.04.07.716863

DOI: https://doi.org/10.64898/2026.04.07.716863