Skip to content

About

Python 3 rewrite of ONTbarcoder 2.3: demultiplexing and barcode calling for Oxford Nanopore reads, with a rebuilt GUI and added analysis tools.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

ONTbarcoder v3

Desktop tool for demultiplexing and analysis of Oxford Nanopore (ONT) reads using DNA barcodes.

This is a fork / version-3 rewrite of ONTbarcoder 2.0 (Srivathsan et al. 2024, Cladistics 40: 192–203, https://doi.org/10.1111/cla.12566). The barcode-calling algorithm is unchanged; version 3 rebuilds the interface, ports the pipeline to Python 3 with deterministic multiprocessing, and adds a set of analysis tools (FASTA Compare, FASTA Tools, FASTQ Inspector, BLAST, Best Sequence, Notes, Parameter Sweep) plus a non-coding marker mode.

See CHANGELOG.md for the full list of differences from the original.

What's new in 3.7.1

  • Help icons: a ? next to each panel's title opens the matching section of the manual.
  • BLAST: Result checks per search, a retry/final-retry scheme for searches NCBI never answers, and a redesigned Summary sheet (key figures, best-hit identity, sequences to review, run details).
  • HTML report works offline (inline SVG charts) and gains an Intra-sample variants section, a read funnel and Status / Variants columns.
  • The sidebar tabs remember their last panel.

What's new in 3.7.0

  • BLAST results workbook with a Summary sheet (input files, reference, parameters, sequences per file and how many were identified to species, genus, family or order) and a Best hit sheet with one row per sequence: the hit that best agrees with the expected taxonomy, not just BLAST's first.
  • Best Sequence accepts whole folders, splits the sequences it cannot identify by cause (_no_blast_hit, _tax_mismatch), and Open in Best Sequence from BLAST now starts a clean selection.
  • Warnings for repeated FASTA headers in BLAST, Best Sequence and FASTA Tools, and no more empty FASTA files in any utility.
  • Intra-sample variants exported by tier (quality variants and contamination / paralog alerts) and a final retry for BLAST sequences without hits.
  • FASTA Tools / FASTA Compare / Parameter Sweep improvements (header fields by key name and OR, ignore length differences at the ends, a table of the sweep combinations).
  • Interface: clearer reference-file drop zones, one drag-over look for every drop target, and tooltips that no longer vanish on scaled displays (including 4K).

Screenshots

Conventional mode Real-time mode
Conventional mode Real-time mode
Single completed FASTQ file FASTQ files generated live during sequencing

Light and dark themes (toggle in the top bar), with the sidebar split into Workflow and Utilities tabs:

Dark theme

Releases (ready-to-run executables)

Prebuilt bundles are published on the Releases page — no Python install needed:

Platform Asset
Windows ONTbarcoder3_win.zip
Linux ONTbarcoder3_linux.tar.gz

Unpack and run the ONTbarcoder3 executable.

Running from source

python -m venv .venv
# Windows: .venv\Scripts\activate    |    Linux/macOS: source .venv/bin/activate
pip install -r requirements.txt
python ONTbarcoder3.py

Requires Python 3.11+ (tested on 3.13). For real-time barcoding you also need Dorado and the POD5 tooling installed and on PATH.

Project layout

ONTbarcoder3.py          Main application / GUI
_utilities/              Worker pipeline + tool panels
  pipeline.py            Deterministic multiprocessing worker pipeline
  batch_sweep.py / batch_sweep_panel.py / best_seq_panel.py /
  blast_panel.py / compare_panel.py / fasta_tools.py /
  fastq_inspector.py / notes_panel.py / shared.py
  orf_trim_fasta.py      ORF trimming (FASTA Tools → Trim to coding ORF; also a CLI)
_mafftfiles/             Bundled MAFFT (disttbfast) + parameter files
_profiles/               Saved parameter profiles + BLAST config (git-ignored)
_notes/                  Markdown notes shown in the Notes panel
guide/                   User manual (HTML) + screenshots
icon.ico                 Application icon

ONTbarcoder3.spec        PyInstaller recipe — Windows
ONTbarcoder3_linux.spec  PyInstaller recipe — Linux
build_linux.sh           Linux build driver (runs PyInstaller, assembles the
                         bundle, produces dist/ONTbarcoder3_linux.tar.gz)
build_linux_docker.sh    Same build inside a manylinux container
linux/                   Linux packaging assets
  launch.sh              Launcher: checks the Qt/xcb prerequisites first
  install.sh             Desktop-entry installer
  icon.svg / ONTbarcoder3.desktop.in

Building the executables

Both platforms build from the same sources; only the spec and the bundled MAFFT binary differ (_mafftfiles/disttbfast.exe vs _mafftfiles/disttbfast). Build each one on its own platform — PyInstaller does not cross-compile.

# Windows
pyinstaller ONTbarcoder3.spec          # -> dist/ONTbarcoder3/

# Linux
./build_linux.sh                       # -> dist/ONTbarcoder3_linux.tar.gz

The specs collect the whole _utilities package rather than listing panels one by one, so a newly added panel cannot be silently left out of the bundle.

Credits

  • Original software: Amrita Srivathsan, V. Feng, D. Suárez, B. Emerson & R. Meier — ONTbarcoder 2.0.
  • Version 3 development: Eduardo Tovar Luque — Instituto Humboldt, 2026.

License

Licensed under the GNU General Public License v3.0 — see LICENSE. As a derivative of ONTbarcoder 2.0, this fork keeps the upstream copyleft terms.

About

Python 3 rewrite of ONTbarcoder 2.3: demultiplexing and barcode calling for Oxford Nanopore reads, with a rebuilt GUI and added analysis tools.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages