Skip to main content

NOSE — Novel Species Identification Pipeline (Computational Systems Biology Lab @ IIT Madras)

Project description

NOSE — Novel Species Identification Pipeline

Computational Systems Biology Lab @ IIT Madras

License: MIT Snakemake ≥8 Python ≥3.9 PyPI

A modular Snakemake toolkit for identifying and characterizing novel microbial species from genome assemblies.

📖 Full Documentation  ·  🐛 Report an Issue  ·  📦 Pipeline Code


What is NOSE?

NOSE takes a directory of genome FASTA files and returns — with full scientific evidence — whether each genome belongs to an already-described species or is a candidate novel organism.

FASTA Files → M1: QC & Taxonomy → M2: Novelty Screen → Novel / Known
                                                              ↓
                                          M3: Phylogenetic Tree
                                          M4: Metagenome Mapping
                                          M5: Functional Annotation
                                          M6: Metabolic Modeling
Module What it does Key output
M1 Assembly QC + taxonomy (QUAST, CheckM2, GTDB-Tk) genome_summary.csv
M2 ANI / AAI / POCP against RefSeq type strains potential_novel.csv
M3 ML phylogenetic trees (GToTree + IQ-TREE) Newick + iTOL files
M4 Metagenome abundance mapping (sylph) final_report.csv
M5 Functional annotation (Prokka, antiSMASH, ABRICATE) functional_summary.csv
M6 Metabolic model reconstruction (CarveMe, MEMOTE) SBML + model_summary.csv

Installation

1. Install the CLI package

pip install nose-pipeline

2. Clone the pipeline

git clone https://github.com/RamanLab/NOSE.git
cd NOSE

3. Set up conda + Snakemake

nose-setup

Installs Miniconda3 if needed, creates a snakemake conda environment with Snakemake ≥ 8.

4. Download databases

nose-db

Downloads CheckM2, GTDB-Tk, EukCC, and CAT databases as needed.

5. Launch the web UI

nose-ui

Opens http://localhost:5050 — fill in paths, click Run Module.


CLI Commands

Command Description
nose-ui Start the web UI (default port 5050)
nose-setup Install conda environment
nose-db Download databases
nose-info Show version, env status, paths
nose-info        # check everything is set up correctly
nose-ui --port 8080 --no-browser   # custom port, skip browser open
nose-setup --env-name myenv        # custom env name
nose-db --skip-gtdbtk              # skip the 66 GB GTDB-Tk download

System Requirements

  • OS: Linux, macOS, or Windows (WSL2)
  • Python: ≥ 3.9
  • Conda: Miniconda3 or Anaconda (auto-installed by nose-setup if missing)
  • RAM: ≥ 16 GB recommended (GTDB-Tk loads ~66 GB DB)
  • Disk: ≥ 100 GB for all databases

Developed by

Computational Systems Biology Lab @ IIT Madras


License

MIT License — see LICENSE

Project details


Download files

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

Source Distribution

nose_pipeline-1.0.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

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

nose_pipeline-1.0.1-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file nose_pipeline-1.0.1.tar.gz.

File metadata

  • Download URL: nose_pipeline-1.0.1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nose_pipeline-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d482775bb73f7d5f3eb57c2bf0b1850d0caa17598ede79b537c58e13cc95cc66
MD5 e9d3307c7bf4a68f1d092b2e7bd53b21
BLAKE2b-256 d845b586f269cf35ae224acab0b259ca26cc1eb0d039bcc866188cca0e4d161e

See more details on using hashes here.

File details

Details for the file nose_pipeline-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: nose_pipeline-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for nose_pipeline-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5306ab2d800e91724f2a76af66772103c8d7800f0596f1bdbaa93ee31be1a562
MD5 f3748f6cd0ddfbb3207f7674258949dd
BLAKE2b-256 387bd769f4088638cbdf09b2f6a41bb2ccca2e0ed14fc1eff9b480d2cd091965

See more details on using hashes here.

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