# cami-challenge/camisim architecture

> Architecture diagram of the GitHub repository cami-challenge/camisim, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cami-challenge/camisim
- Repository: https://github.com/cami-challenge/camisim

## Overview

CAMISIM is a Nextflow-based simulator for microbial communities and corresponding shotgun metagenomic datasets. The principal workflow starts with a user-configured simulation and produces simulated reads; the repository also contains a metatranscriptomic workflow, genome/strain preparation, abundance and taxonomy handling, multiple read-simulator adapters, and reference-aware output processing. README establishes the product purpose and Nextflow version, while most implementation files were not sampled, so internal workflow links are shown as unverified rather than asserted calls.

Main entry points: [`pipelines/metagenomic/metagenomic.nf`](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/metagenomic.nf) (Metagenomic workflow), [`pipelines/metatranscriptomic/metatranscriptomic.nf`](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/metatranscriptomic.nf) (Metatranscriptomic workflow), [`main.nf`](https://github.com/cami-challenge/camisim/blob/master/main.nf) (Nextflow entry), [`pipelines/metagenomic/scripts/prepare_strain_simulation.py`](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/prepare_strain_simulation.py) (Genome preparation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_simulation["Simulation workflows"]
  node_entry["Nextflow entry<br/>[main.nf]"]
  node_meta_wf["Metagenomic workflow<br/>[metagenomic.nf]"]
  node_transcript_wf["Metatranscriptomic workflow"]
  node_sample_sim["Sample simulation"]
end

subgraph group_metagenome["Metagenome modeling"]
  node_genome_prep["Genome preparation"]
  node_genome_fetch["Genome acquisition<br/>[get_genomes.py]"]
  node_strain_pick["Strain selection"]
  node_community_dist["Community abundance"]
  node_taxonomy["Taxonomy construction"]
end

subgraph group_transcriptome["Transcriptome modeling"]
  node_gene_abund["Gene abundance"]
  node_seq_extract["Feature sequence extraction"]
  node_expression["Expression profiles"]
  node_transcriptome_build["Transcriptome construction"]
end

subgraph group_readgen["Read generation"]
  node_art["ART simulator"]
  node_nanosim["NanoSim adapter"]
  node_wgsim["Wgsim adapter"]
  node_pbsim["PBSIM3 adapter"]
end

subgraph group_outputs["Output processing"]
  node_anonymization["Read anonymization<br/>[anonymizer.py]"]
  node_goldstandard["Gold-standard mapping"]
  node_reads["Simulated read datasets"]
end

node_user(("Simulation user"))

node_user -->|"runs simulation"| node_entry
node_entry -->|"produces datasets"| node_reads
node_entry -.->|"dispatches"| node_meta_wf
node_entry -.->|"dispatches"| node_transcript_wf
node_meta_wf -.->|"simulates samples"| node_sample_sim
node_meta_wf -.->|"prepares genomes"| node_genome_prep
node_meta_wf -.->|"models abundance"| node_community_dist
node_meta_wf -.->|"builds taxonomy"| node_taxonomy
node_genome_prep -.->|"uses genomes"| node_genome_fetch
node_genome_prep -.->|"selects strains"| node_strain_pick
node_meta_wf -.->|"selects simulator"| node_art
node_meta_wf -.->|"selects simulator"| node_nanosim
node_meta_wf -.->|"selects simulator"| node_wgsim
node_transcript_wf -.->|"models abundance"| node_gene_abund
node_transcript_wf -.->|"creates profiles"| node_expression
node_transcript_wf -.->|"builds transcriptome"| node_transcriptome_build
node_expression -->|"extracts features"| node_seq_extract
node_transcriptome_build -->|"extracts features"| node_seq_extract
node_transcript_wf -.->|"selects simulator"| node_pbsim
node_meta_wf -.->|"anonymizes reads"| node_anonymization
node_meta_wf -.->|"formats mappings"| node_goldstandard

click node_entry "https://github.com/cami-challenge/camisim/blob/master/main.nf"
click node_meta_wf "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/metagenomic.nf"
click node_transcript_wf "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/metatranscriptomic.nf"
click node_sample_sim "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/sample_wise_simulation.nf"
click node_genome_prep "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/prepare_strain_simulation.py"
click node_genome_fetch "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/get_genomes.py"
click node_strain_pick "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/pick_random_strains.py"
click node_community_dist "https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/get_community_distribution.py"
click node_taxonomy "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/build_ncbi_taxonomy.py"
click node_gene_abund "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/get_gene_abundance.py"
click node_seq_extract "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/sequence_extractor.py"
click node_expression "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/create_expression_profile_pbsim3.py"
click node_transcriptome_build "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/create_transcriptome_nanosim.py"
click node_art "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_art.nf"
click node_nanosim "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_nansoim3.nf"
click node_wgsim "https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_wgsim.nf"
click node_pbsim "https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/read_simulators/read_simulator_pbsim3.nf"
click node_anonymization "https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/anonymizer.py"
click node_goldstandard "https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/goldstandardfileformat.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_meta_wf,node_transcript_wf,node_sample_sim,node_user toneBlue
class node_genome_prep,node_genome_fetch,node_strain_pick,node_community_dist,node_taxonomy toneAmber
class node_gene_abund,node_seq_extract,node_expression,node_transcriptome_build toneMint
class node_art,node_nanosim,node_wgsim,node_pbsim toneRose
class node_anonymization,node_goldstandard,node_reads toneIndigo
```

## Components

### Simulation workflows

- [Nextflow entry](https://github.com/cami-challenge/camisim/blob/master/main.nf): `main.nf`
- [Metagenomic workflow](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/metagenomic.nf): `pipelines/metagenomic/metagenomic.nf`
- [Metatranscriptomic workflow](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/metatranscriptomic.nf): `pipelines/metatranscriptomic/metatranscriptomic.nf`
- [Sample simulation](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/sample_wise_simulation.nf): `pipelines/metagenomic/sample_wise_simulation.nf`

### Metagenome modeling

- [Genome preparation](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/prepare_strain_simulation.py): `pipelines/metagenomic/scripts/prepare_strain_simulation.py`
- [Genome acquisition](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/get_genomes.py): `pipelines/metagenomic/scripts/get_genomes.py`
- [Strain selection](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/pick_random_strains.py): `pipelines/metagenomic/scripts/pick_random_strains.py`
- [Community abundance](https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/get_community_distribution.py): `pipelines/shared/scripts/get_community_distribution.py`
- [Taxonomy construction](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/scripts/build_ncbi_taxonomy.py): `pipelines/metagenomic/scripts/build_ncbi_taxonomy.py`

### Transcriptome modeling

- [Gene abundance](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/get_gene_abundance.py): `pipelines/metatranscriptomic/scripts/get_gene_abundance.py`
- [Feature sequence extraction](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/sequence_extractor.py): `pipelines/metatranscriptomic/scripts/sequence_extractor.py`
- [Expression profiles](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/create_expression_profile_pbsim3.py): `pipelines/metatranscriptomic/scripts/create_expression_profile_pbsim3.py`
- [Transcriptome construction](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/scripts/create_transcriptome_nanosim.py): `pipelines/metatranscriptomic/scripts/create_transcriptome_nanosim.py`

### Read generation

- [ART simulator](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_art.nf): `pipelines/metagenomic/read_simulators/read_simulator_art.nf`
- [NanoSim adapter](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_nansoim3.nf): `pipelines/metagenomic/read_simulators/read_simulator_nansoim3.nf`
- [Wgsim adapter](https://github.com/cami-challenge/camisim/blob/master/pipelines/metagenomic/read_simulators/read_simulator_wgsim.nf): `pipelines/metagenomic/read_simulators/read_simulator_wgsim.nf`
- [PBSIM3 adapter](https://github.com/cami-challenge/camisim/blob/master/pipelines/metatranscriptomic/read_simulators/read_simulator_pbsim3.nf): `pipelines/metatranscriptomic/read_simulators/read_simulator_pbsim3.nf`

### Output processing

- [Read anonymization](https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/anonymizer.py): `pipelines/shared/scripts/anonymizer.py`
- [Gold-standard mapping](https://github.com/cami-challenge/camisim/blob/master/pipelines/shared/scripts/goldstandardfileformat.py): `pipelines/shared/scripts/goldstandardfileformat.py`
- **Simulated read datasets**

### Other components

- **Simulation user**

## Connections

- Simulation user → Nextflow entry: runs simulation (evidence: `README.md`)
- Nextflow entry → Simulated read datasets: produces datasets (evidence: `README.md`)
- Nextflow entry → Metagenomic workflow: dispatches
- Nextflow entry → Metatranscriptomic workflow: dispatches
- Metagenomic workflow → Sample simulation: simulates samples
- Metagenomic workflow → Genome preparation: prepares genomes
- Metagenomic workflow → Community abundance: models abundance
- Metagenomic workflow → Taxonomy construction: builds taxonomy
- Genome preparation → Genome acquisition: uses genomes
- Genome preparation → Strain selection: selects strains
- Metagenomic workflow → ART simulator: selects simulator
- Metagenomic workflow → NanoSim adapter: selects simulator
- Metagenomic workflow → Wgsim adapter: selects simulator
- Metatranscriptomic workflow → Gene abundance: models abundance
- Metatranscriptomic workflow → Expression profiles: creates profiles
- Metatranscriptomic workflow → Transcriptome construction: builds transcriptome
- Expression profiles → Feature sequence extraction: extracts features (evidence: `pipelines/metatranscriptomic/scripts/create_expression_profile_pbsim3.py`)
- Transcriptome construction → Feature sequence extraction: extracts features (evidence: `pipelines/metatranscriptomic/scripts/create_transcriptome_nanosim.py`)
- Metatranscriptomic workflow → PBSIM3 adapter: selects simulator
- Metagenomic workflow → Read anonymization: anonymizes reads
- Metagenomic workflow → Gold-standard mapping: formats mappings
