Sovereign 8s.is mirror of standardgalactic/nomadic
  • Python 98.1%
  • CSS 1.8%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Bernd Bohmeier d17a45eaf7
Some checks failed
build / build (macos-latest) (push) Has been cancelled
build / build (ubuntu-latest) (push) Has been cancelled
build / ruff (push) Has been cancelled
docs / deploy (push) Has been cancelled
Merge pull request #84 from JasonAHendry/fixtemplate_sampletypes
Generate correct sample_type names for nomadic from template
2026-03-26 16:55:54 +01:00
.github/workflows Update to use main now as main branch 2025-07-29 15:55:03 +02:00
build/conda Release version 0.8.0 2026-03-26 16:47:41 +01:00
docs Update faq can I run multiple instances of nomadic 2026-03-23 11:56:56 +01:00
environments Add openpyxl dependency 2025-12-11 14:40:14 +01:00
example_data Update example data. 2024-07-13 10:18:18 +02:00
scripts Update example data. 2024-07-13 10:18:18 +02:00
src/nomadic Added substitute to geenrate correct sample_type names 2026-03-26 17:06:55 +02:00
tests Make sure not heavy libs are imported to it fast 2025-07-23 14:29:03 +02:00
.gitignore Igore results and resources directories. 2024-07-21 04:59:31 +02:00
LICENSE Initial commit. 2023-06-12 23:10:02 +02:00
mkdocs.yml Rename section to just Output Files 2026-02-04 13:17:51 +01:00
pyproject.toml Initial commit. 2023-06-12 23:10:02 +02:00
README.md Enhance README with variant caller options 2025-11-13 01:39:21 +01:00
setup.cfg Release version 0.8.0 2026-03-26 16:47:41 +01:00
setup.py Format files with ruff 2025-07-04 12:35:14 +02:00

build View - Docs Conda Downloads OS - Linux | OSX install with bioconda

Overview

Nomadic is a real-time bioinformatics pipeline and dashboard for nanopore sequencing data. While sequencing is still ongoing, it performs read mapping and sample quality control, as well as variant calling and annotation. This information is displayed in real-time to a graphical dashboard that has interactive features.

Please visit our documentation to learn more.

Features

  • Real-time read mapping with Minimap2.
  • Real-time sample quality control and amplicon coverage evaluation.
  • Real-time variant calling with bcftools or delve (our own variant caller). These calls are preleiminary; treat with caution.
  • Support for different reference genomes or amplicons panels.

Installation

Nomadic can be installed from bioconda

conda install bioconda::nomadic

Quickstart

Navigate to a directory where your nomadic files should live and setup a workspace with

nomadic start pfalciparum

Afterwards, navigate to the newly created workspace, create a metadata file and start your experiment:

cd nomadic
nomadic realtime <expt_name>

For more detailed information, see our documentation.

Development

If you would like to develop Nomadic you can install it from source. First, clone the github repository

git clone https://github.com/JasonAHendry/nomadic.git

and then create the development conda environment, and activated it:

conda env create -f environments/dev.yml
conda activate nomadic-dev

Finally, install the package locally in development mode:

pip install -e .

Please note that if new dependencies are added, you will have to update your conda environment. For this, run:

conda env update -f environments/dev.yml

Testing

To test Nomadic, we have written a small python script that simulates nanopore sequencing:

python scripts/simulate_sequencing.py

This will move FASTQ files into the directory example_data/minknow/fastq_pass, which you can process with nomadic realtime.

Additionally, if you followed our development instructions you can test with:

pytest

Building the documentation

The documentation was created using MkDocs. You can serve it locally with:

conda env create -f environments/dev.yml
mkdocs serve

Acknowledgements

This work was funded by the Bill and Melinda Gates Foundation (INV-003660, INV-048316).