How octavianix/sangercap works
SangerCap is a Sanger-trace sequencing workflow for microbiology labs. Users start a run from the CLI or desktop, which reaches the shared run service and pipeline: traces are read and trimmed, reads may be grouped, contigs assembled, and sequences identified using BLAST candidates plus end-to-end alignment and taxonomic classification. Results include review flags and HTML reports. The README also documents editing, vector screening, database management, scheduled runs and remote-server use. Pipeline-stage links are supported by the README and pipeline excerpt; unsampled interface wiring is left unasserted or marked unverified.
Main entry points: pipeline.py Pipeline · runservice.py Run service · shell.py Desktop app · blast.py BLAST search
Components 26
User interfaces
- CLI
sangercap/interfaces/cli/main.py - Desktop app
sangercap/interfaces/desktop/shell.py - Run service
sangercap/interfaces/runservice.py
Analysis pipeline
- Pipeline
sangercap/core/pipeline.py - Trace and sequence formats
sangercap/core/formats.py - ABI trace reader
sangercap/core/abi.py - Quality trimming
sangercap/core/trim.py - Read grouping
sangercap/core/cluster.py - CAP3 assembly
sangercap/core/cap3.py - BLAST search
sangercap/core/blast.py - Global alignment
sangercap/core/align.py - Taxonomic classification
sangercap/core/classify.py - Trace editor
sangercap/core/editor.py - Vector screening
sangercap/core/vector.py
Results and review
- Review flags
sangercap/core/pipeline.py - HTML report
sangercap/core/report_html.py
Operations and integrations
- Database manager
sangercap/core/dbmanager.py - Marker database catalogue
sangercap/core/databases.py - Scheduled runs
sangercap/adapters/scheduler.py - Remote server adapter
sangercap/adapters/remote.py - Result email
sangercap/adapters/mailer.py - Settings and tool discovery
sangercap/config.py
Other components
- Lab user
- TraceTuner
- NCBI BLAST
- CAP3 tool
Connections 27
- Lab user → CLI: starts run
README.md - Lab user → Desktop app: opens traces
README.md - CLI → Run service: delegates run
sangercap/interfaces/cli/main.py - Desktop app → Run service: submits run
- Run service → Pipeline: executes
sangercap/interfaces/runservice.py - Pipeline → Trace and sequence formats: reads and writes
sangercap/core/pipeline.py - Trace and sequence formats → ABI trace reader: reads ABI
sangercap/core/formats.py - Pipeline → Quality trimming: trims reads
README.md - Pipeline → Read grouping: groups reads
README.md - Pipeline → CAP3 assembly: assembles groups
sangercap/core/pipeline.py - CAP3 assembly → CAP3 tool: runs
README.md - Pipeline → BLAST search: searches candidates
sangercap/core/pipeline.py - BLAST search → NCBI BLAST: queries online
README.md - Pipeline → Taxonomic classification: classifies hits
sangercap/core/pipeline.py - Taxonomic classification → Global alignment: aligns candidates
sangercap/core/classify.py - Pipeline → Review flags: flags samples
README.md - Pipeline → HTML report: writes report
sangercap/core/pipeline.py - Desktop app → Trace editor: provides editing
README.md - Desktop app → Vector screening: provides screening
README.md - BLAST search → Database manager: searches local databases
- Database manager → Marker database catalogue: uses catalogue
sangercap/core/dbmanager.py - Scheduled runs → Database manager: updates databases
- Scheduled runs → Run service: schedules runs
- Remote server adapter → Lab user: returns results
- Run service → Result email: emails results
sangercap/interfaces/runservice.py - Run service → Settings and tool discovery: uses settings
sangercap/interfaces/runservice.py - Quality trimming → TraceTuner: runs when configured