Skip to main content

BiNgo Genome Viewer — a lightweight browser-based genomics viewer

Project description

BiNgo Genome Viewer

A lightweight, browser-based genomics viewer for visualizing genomes, coverage tracks, read alignments, variants, and annotations. Built as a modern alternative to IGV.

Supported File Formats

Type Formats
Genome GenBank (.gb, .gbk), FASTA (.fasta, .fa)
Coverage BigWig (.bw), WIG (.wig), BedGraph (.bedgraph, .bdg)
Reads BAM (.bam + .bai index)
Variants VCF (.vcf, .vcf.gz)
Annotations BED (.bed), GFF (.gff, .gff3), GTF (.gtf), GenBank (.gb)

Quick Start

Requires Python 3.10 or newer. Download from python.org if needed.

Install with pip (recommended)

No Node.js required — the frontend is pre-built and bundled.

pip install BiNgoViewer
bingo

Options:

bingo --port 9000        # use a custom port
bingo --no-browser       # start without opening the browser
bingo --install          # create a desktop shortcut

Windows (one-click)

Double-click Install_Windows.bat. It will install Python dependencies into a local environment and launch the viewer. No command line needed.

macOS / Linux (one-click)

Double-click Install_macOS.command (or run it from a terminal). It will create a virtual environment, install dependencies, and launch the viewer.

Permission denied? Run once in Terminal:

chmod +x Install_macOS.command

Docker

No Python or Node.js required — everything runs inside the container.

cd app
docker compose up --build

Then open http://localhost:8000.

Troubleshooting

Problem Solution
python not found Install Python 3.10+ and check Add to PATH during setup
pip install fails Try pip install --user BiNgoViewer or use a virtual environment
Port 8000 in use Run bingo --port 9000 (or any free port)
Browser doesn't open Visit http://localhost:8000 manually
Server won't stop The server auto-exits when you close all browser tabs; or press Ctrl+C

Usage

  1. Load files — Use the file picker or drag and drop. Genome and track files are auto-classified by extension.
  2. Navigate — Click and drag on tracks to pan; scroll wheel to zoom; use the coordinate bar to jump to a region.
  3. Track settings — Click the gear icon to adjust height, color, scale, and bar width.
  4. Reorder tracks — Drag the grip handle on any track label.
  5. Export — Save the current view as SVG or PNG.
  6. Save session — Store your workspace and restore it later.

Project Structure

├── Install_Windows.bat         # Windows installer (double-click)
├── Install_macOS.command       # macOS / Linux installer (double-click)
├── README.md
├── pyproject.toml              # pip package definition
├── bingoviewer/                # Installable Python package
│   ├── cli.py                  # `bingo` CLI entry point
│   ├── server/                 # FastAPI backend (bundled)
│   └── frontend_dist/          # Pre-built React frontend
└── app/                        # Application source code
    ├── backend/                # Python (FastAPI) REST API
    └── frontend/               # React (Vite) user interface

Citation

If you use this software in your research, please cite:

Ngo, B. (2026). BiNgo Genome Viewer (v1.2.0) [Software].

License

All rights reserved. Contact the author for licensing inquiries.

Project details


Release history Release notifications | RSS feed

This version

1.3.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bingoviewer-1.3.3.tar.gz (119.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bingoviewer-1.3.3-py3-none-any.whl (126.8 kB view details)

Uploaded Python 3

File details

Details for the file bingoviewer-1.3.3.tar.gz.

File metadata

  • Download URL: bingoviewer-1.3.3.tar.gz
  • Upload date:
  • Size: 119.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bingoviewer-1.3.3.tar.gz
Algorithm Hash digest
SHA256 f3f0f56bf6c18a9afc58628d742970d06dfce6a80de19f6aae62e5dc327b8579
MD5 c0c6c8e52bf4e0ec4134924b5f776a63
BLAKE2b-256 44b8cf0399d2e3e8206bb77bce41b9ad705a67df1ea04b4ae1bc9314146be0de

See more details on using hashes here.

Provenance

The following attestation bundles were made for bingoviewer-1.3.3.tar.gz:

Publisher: publish.yml on billy-ngo/bingo-genome-viewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bingoviewer-1.3.3-py3-none-any.whl.

File metadata

  • Download URL: bingoviewer-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 126.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bingoviewer-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a638bb6e55972ff4ff36a977f08e143923024fc427f1065df36f3a84c125f615
MD5 73fafe168e2bff9cbfe234ecda7c08ba
BLAKE2b-256 3578cf37305191aa5c0a70b697d73efb6fa8b67d5e5e8f9a9b7e0e69b02881c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for bingoviewer-1.3.3-py3-none-any.whl:

Publisher: publish.yml on billy-ngo/bingo-genome-viewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page