Skip to content

irit 0.4.0

Choose a tag to compare

@github-actions github-actions released this 13 Nov 18:06
· 35 commits to main since this release

New: seqplan (plan a sequencing run), long-read isolates (flye, medaka) and metagenomes to
MAGs (megahit, coverm_contig, metabat2) in irit-mcp, and msascope's menu bar and Mac App Store
preparation. Fixes from an AI agent reproducing Neumann et al. 2025 (K. pneumoniae from alfalfa
sprouts, MRA e01270-25) through irit-mcp alone (#14-#19), and from the depth experiment and the
nanopore run (#21-#25).

irit-mcp

  • A used run folder is refused (#14): irit-mcp won't start when <runs-dir>/<run-id>/ already
    holds a record. Reusing --run-id restarted call numbering and overwrote run.json, replay.sh,
    the RO-Crate and calls/NNN.*, losing the earlier session's record.
  • Databases fall back to dblock.lock (#16): with no path given and the variable unset,
    gtdbtk_classify_wf, gtdbprep_ani (data and index, now optional), checkm2, bakta and
    amrfinder use the one database of that kind locked in the working folder, and warnings names
    it; two candidates are refused.
  • Warnings from stderr (#18): CheckM2's scikit-learn InconsistentVersionWarning and
    AMRFinderPlus's WARNING: lines go into warnings. AMRFinderPlus from an unactivated conda
    environment gets CONDA_PREFIX set to it.
  • describe_run summarises by default (#19): tool, status, version, error, warnings and outputs
    per call; detail: true for the full records (170 kB for 26 calls), call_id for one.
  • amrfinder names Bakta's trimmed AMRFinderPlus copy instead of calling it an incomplete download;
    replay.sh says where a gtdbprep ani call's sketches come from on another machine (#19).

isotable

  • GTDB from the ANI screen (#15): classify/ani_screen/*.ani_summary.tsv (reference_taxonomy)
    counts as the GTDB classification, so a run where the screen assigned every genome no longer
    comes out incomplete under --require gtdb.
  • GC for Shovill assemblies (#15), over the same contigs of 500 bp or more as the contig count,
    length and N50 (QUAST's rule); the requirement help names the cutoff. On the paper's isolates:
    57.04 / 57.15 / 57.35 against the paper's 57.06 / 57.15 / 57.35.

dblock

  • No download without the prepare program (#17): fetch refuses a database whose prepare
    program (amrfinder_index) isn't on PATH before downloading it, instead of after; plan says
    it won't fetch, and notes databases whose tool isn't installed.

gtdbprep

  • The missing-sketch error says how much would be fetched and suggests --species-only (#19).

Fixes from the depth experiment and the nanopore run (#21-#25)

  • irit-mcp warns when Shovill's genome-size estimate collapses (#22). At 5-10× Shovill
    estimated 0.01-0.11 Mb for a 5.5 Mb genome, subsampled to it and assembled a fragment with
    exit 0. The server reads shovill.log and warns in three cases:

    • Shovill subsampled to a tiny size.
    • The assembly is over twice the estimate. The warning gives the real depth over the assembly,
      since Shovill's own figure is then too high (60× reported at 20×).
    • gsize was given and the assembly is under 70% of it.

    A separate warning comes when the depth over the assembly is under 15×.

  • gtdbprep ani screens the rest when skani can't sketch a genome (#23). Such a genome, e.g. a
    407 bp assembly, is listed as not screened (- markers; screened: false in irit-mcp) with a
    warning. Before, it failed the whole batch.

  • mlst: a warning when it chose the scheme itself and found no ST (#24). A fragmented
    K. pneumoniae got ecoli_achtman_4.

  • CheckM2: a warning above 20 genomes per call (#25). 48 peaked at 7.7 GiB on an 8 GB laptop.

  • Medaka's model file is recorded (#21). Medaka downloads a named model at run time, so the
    server hashes the file Medaka logged into the call's inputs, returns it as model_file, and
    replay.sh notes it.
    batch_size 50 peaked at 4.78 GiB and 25 at 3.66 GiB on the 6 Mb nanopore genome, against 7.36 GiB
    at Medaka's default 100. All three gave the same consensus and the smaller sizes were no slower,
    so the docs and the tool description recommend 50 or 25 on 8 GB machines.

  • isotable reads long-read QC (#21). For a nanopore-only isolate, leanqc's long-read numbers
    stand in for fastp:

    • long_reads and long_read_bases count as reads, and read_q_median counts as quality
      (warn below --min-read-q, default Q10). read_n50 is shown.
    • leanqc's short-read checks (per-position, per-tile, per-read quality and GC, read length) are
      not graded for long-read files, and a note lists them.
    • The nanopore run's ONT sample now passes instead of being incomplete.

seqplan (new)

  • Plan a sequencing run before sequencing: bases and read pairs per isolate at a target
    coverage, isolates per run, runs for N samples, and cost per isolate from a run price you give
    (no built-in prices). It pads each isolate by a barcode-imbalance margin (default 1.3) and counts
    only the usable part of a run (default 0.8 for Illumina). --barcodes caps isolates per run at
    the library kit's barcode count. Kits: MiSeq v2/v3/Micro/Nano, iSeq 100,
    NextSeq 500/550 mid/high, NextSeq 1000/2000 P1-P4, NovaSeq X 1.5B/10B/25B (Illumina
    specifications), plus MinION and Flongle R10.4.1 (reported typical yields, marked as such). There
    are 16 organism presets with NCBI's expected genome size. Every figure carries its source URL
    (seqplan/data/, --list-kits, --list-organisms). Example: K. pneumoniae 5.5 Mb at 50× fits
    29-33 isolates on a MiSeq v3 run and 67 on a NextSeq 2000 P1; at 25×, 59-67 and 134.
  • In the release archives (all platforms, including Windows) and the installer.

irit-mcp

  • seqplan tool: the same plan as JSON, so an agent answers from cited kit figures; it is told
    never to invent a run price.

irit-mcp: metagenomes to MAGs

  • megahit, coverm_contig and metabat2: MEGAHIT 1.2.9 assembly, CoverM 0.8.0 per-contig
    depth (methods: ["metabat"] writes MetaBAT2's depth table) and MetaBAT 2.18 binning, pinned and
    replayable like the isolate tools. Then checkm2 on the bins, gtdbprep_ani and isotable's MAG
    mode. Measured on the laptop in Metagenome to MAGs in 8 GB: a
    Crystal Geyser groundwater sample gave 23 bins (4 high*, 13 medium, 8 of them
    Patescibacteria), every step within an 8 GB cap.
  • MEGAHIT's memory defaults to 4 GB (MEGAHIT's own default, 90% of the machine, ignores memory
    caps); MetaBAT2's seed defaults to 1, so bins repeat. MetaBAT2's version comes from --help,
    in the record and in replay.sh.
  • A failed tool gets a hint when it ran out of memory: CheckM2's SIGKILLed DIAMOND step (use
    lowmem), or any tool killed by a signal.
  • The real-tools workflow runs the three on a two-genome mock metagenome, twice, and replays them.

msascope

  • Menu bar (macOS) with About, Acknowledgements, Hide, Quit, Open, Open Sample Alignment,
    Export, Close File, Close Window, Copy Selection and Select All. Quit, Open, Close Window, Export,
    Copy and Select All are key bindings (⌘ on macOS, Ctrl elsewhere), so the menus show them.
  • Closing the window: on macOS msascope keeps running and a click on its Dock icon opens a new
    window; elsewhere closing the last window quits. Before, it kept running without a window.
  • Finder opens files with msascope (Open With, a drop on the Dock icon): alignments and trees,
    registered as an alternative app, not the default one.
  • Acknowledgements: the licences of every dependency compiled into msascope, plus the Lucide
    icons and Catppuccin palettes, generated with cargo-about and shipped as Acknowledgements.html
    in msascope.app and the Linux archives. Neither shipped them before.
  • Mac App Store edition, prepared: it runs in the App Sandbox (security-scoped bookmarks for
    recent files, File ▸ Allow Access to Folder… for a tree next to the alignment, a clear message
    for a file it may not read); scripts/build-mas-pkg.sh and the msascope-mas.yml workflow build,
    validate and upload it. CI checks that msascope's dependencies stay permissively licensed
    (msascope/deny.toml) and that a sandboxed copy starts and can't read a file nobody chose.

irit-mcp

  • flye and medaka tools: nanopore (and PacBio) isolate assembly. Flye 2.9.6 (read_type
    nano-hq for R10.4.1 hac/sup reads, the default) and Medaka 2.2.2 (medaka_consensus), pinned
    and checked like Shovill: flags read from the release sources, inputs and outdir validated,
    link_as for CheckM2, GTDB-Tk and gtdbprep_ani, the assembly's contig count, length and N50
    recorded for replay. flye also returns each contig's depth and circularity. On one
    K. pneumoniae isolate, ONT reads alone gave the same ST, the same 49 AMRFinderPlus elements,
    the same CheckM2 completeness and the same GTDB species as Illumina, in an 8 GB cap: Flye 22 min
    (3.85 GiB), Medaka 9.4 min (7.36 GiB) (write-up).

isotable

  • Reads Flye's assembly.fasta (with flye.log beside it) and Medaka's consensus.fasta (with
    consensus_probs.hdf beside it) for contigs, length, N50 and GC; when a sample has both, the
    polished one counts and the draft is listed as skipped.

Download

Terminal (Linux or macOS), installs into ~/.local/bin without sudo:

curl -fsSL https://raw.githubusercontent.com/dzulfikar08/irit/main/scripts/install.sh | IRIT_VERSION=v0.4.0 sh
  • Linux command-line tools (static, any distribution): x86_64, aarch64
  • macOS command-line tools (Apple Silicon and Intel, Developer ID signed and notarised): irit-0.4.0-universal-macos.tar.gz
  • msascope for macOS (signed, notarised): msascope-0.4.0.dmg. Open it and drag msascope to Applications.
  • msascope for Linux (glibc 2.39 or newer: Ubuntu 24.04, Debian 13, Fedora 40 or later): x86_64, aarch64
  • Windows (sheetgen, leanqc, isotable, dblock): irit-0.4.0-x86_64-windows.zip. Not code-signed: SmartScreen may warn the first time you run them.

Check downloads with sha256sum -c SHA256SUMS --ignore-missing (macOS: shasum -a 256 -c SHA256SUMS --ignore-missing). More, including checking the macOS signatures: https://dzulfikar08.github.io/irit/install/