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.M. (2026). BiNgo Genome Viewer (v1.7.5) [Software].

License

All rights reserved. Contact the author for licensing inquiries.

Project details


Release history Release notifications | RSS feed

This version

1.8.2

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.8.2.tar.gz (129.5 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.8.2-py3-none-any.whl (136.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bingoviewer-1.8.2.tar.gz
Algorithm Hash digest
SHA256 bcadb4cb83c579832673119f1508d800d8d9fd5c2cc1e62ad5c99d47229066f8
MD5 4c7015d562358a1e97a8383793ad2526
BLAKE2b-256 57f71c512f6200199bab2cec602ec400d26840a43c2a712b66ebc622730714b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for bingoviewer-1.8.2.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.8.2-py3-none-any.whl.

File metadata

  • Download URL: bingoviewer-1.8.2-py3-none-any.whl
  • Upload date:
  • Size: 136.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.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e0e8ae72cb9947c6d5cef382c1f38262897e368b6fdd34c4ce8a9e9110071ac
MD5 fb913fa6efd0f9df6c178bd63f5d1d94
BLAKE2b-256 66863393fdddc27f259676fcb92fa3d5ebaea618e9b18d4f7e8f9bb031515f0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for bingoviewer-1.8.2-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