# harvardinformatics/cactus-snakemake architecture

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

- Interactive diagram: https://gitdiagram.com/harvardinformatics/cactus-snakemake
- Repository: https://github.com/harvardinformatics/cactus-snakemake

## Overview

cactus-snakemake provides Snakemake workflows for running Cactus whole-genome alignment and Minigraph-Cactus pangenome inference on SLURM clusters. The user selects a workflow and config; Snakemake schedules it, and the workflow runs the relevant Cactus operations. Separate workflows support adding genomes, adding outgroups, and replacing genomes in an existing alignment. The graph preserves those documented capabilities and the sampled tree, update, and shared utility modules. Snakefile internals were not sampled, so workflow-to-helper call relationships are not asserted.

Main entry points: [`config-templates`](https://github.com/harvardinformatics/cactus-snakemake/tree/main/config-templates) (Pipeline configs), [`cactus.smk`](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus.smk) (Progressive alignment), [`cactus_minigraph.smk`](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_minigraph.smk) (Minigraph pangenome), [`cactus_update.smk`](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_update.smk) (Add genome)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflows["Alignment workflows"]
  node_progressive["Progressive alignment<br/>[cactus.smk]"]
  node_minigraph["Minigraph pangenome"]
end

subgraph group_updates["Alignment updates"]
  node_add_genome["Add genome<br/>[cactus_update.smk]"]
  node_add_outgroup["Add outgroup"]
  node_replace_genome["Replace genome<br/>[cactus_replace.smk]"]
end

subgraph group_shared["Shared utilities"]
  node_cactuslib["Cactus utilities<br/>[cactuslib.py]"]
  node_treelib["Tree processing<br/>[treelib.py]"]
  node_updatelib["Update preparation<br/>[updatelib.py]"]
end

subgraph group_execution["Execution"]
  node_snakemake["Snakemake"]
  node_slurm["SLURM cluster"]
  node_config["Pipeline configs"]
  node_cactus_tools["Cactus tools"]
end

node_user(("Pipeline user"))

node_user -->|"runs workflow"| node_snakemake
node_user -->|"selects settings"| node_config
node_snakemake -->|"runs"| node_progressive
node_snakemake -->|"runs"| node_minigraph
node_snakemake -->|"runs"| node_add_genome
node_snakemake -->|"runs"| node_add_outgroup
node_snakemake -->|"runs"| node_replace_genome
node_config -->|"configures"| node_progressive
node_config -->|"configures"| node_minigraph
node_config -->|"configures"| node_add_genome
node_config -->|"configures"| node_add_outgroup
node_config -->|"configures"| node_replace_genome
node_snakemake -->|"submits jobs"| node_slurm
node_progressive -->|"runs alignment"| node_cactus_tools
node_minigraph -->|"runs pangenome"| node_cactus_tools
node_add_genome -->|"updates alignment"| node_cactus_tools
node_add_outgroup -->|"adds outgroup"| node_cactus_tools
node_replace_genome -->|"replaces genome"| node_cactus_tools
node_treelib -->|"imports spacing helper"| node_cactuslib
node_updatelib -->|"imports spacing helper"| node_cactuslib

click node_progressive "https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus.smk"
click node_minigraph "https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_minigraph.smk"
click node_add_genome "https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_update.smk"
click node_add_outgroup "https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_add_outgroup.smk"
click node_replace_genome "https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_replace.smk"
click node_config "https://github.com/harvardinformatics/cactus-snakemake/tree/main/config-templates"
click node_cactuslib "https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/cactuslib.py"
click node_treelib "https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/treelib.py"
click node_updatelib "https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/updatelib.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_progressive,node_minigraph,node_user toneBlue
class node_add_genome,node_add_outgroup,node_replace_genome toneAmber
class node_cactuslib,node_treelib,node_updatelib toneMint
class node_snakemake,node_slurm,node_config,node_cactus_tools toneRose
```

## Components

### Alignment workflows

- [Progressive alignment](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus.smk): `cactus.smk`
- [Minigraph pangenome](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_minigraph.smk): `cactus_minigraph.smk`

### Alignment updates

- [Add genome](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_update.smk): `cactus_update.smk`
- [Add outgroup](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_add_outgroup.smk): `cactus_add_outgroup.smk`
- [Replace genome](https://github.com/harvardinformatics/cactus-snakemake/blob/main/cactus_replace.smk): `cactus_replace.smk`

### Shared utilities

- [Cactus utilities](https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/cactuslib.py): `lib/cactuslib.py`
- [Tree processing](https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/treelib.py): `lib/treelib.py`
- [Update preparation](https://github.com/harvardinformatics/cactus-snakemake/blob/main/lib/updatelib.py): `lib/updatelib.py`

### Execution

- **Snakemake**
- **SLURM cluster**
- [Pipeline configs](https://github.com/harvardinformatics/cactus-snakemake/tree/main/config-templates): `config-templates`
- **Cactus tools**

### Other components

- **Pipeline user**

## Connections

- Pipeline user → Snakemake: runs workflow (evidence: `README.md`)
- Pipeline user → Pipeline configs: selects settings (evidence: `README.md`)
- Snakemake → Progressive alignment: runs (evidence: `README.md`)
- Snakemake → Minigraph pangenome: runs (evidence: `README.md`)
- Snakemake → Add genome: runs (evidence: `README.md`)
- Snakemake → Add outgroup: runs (evidence: `README.md`)
- Snakemake → Replace genome: runs (evidence: `README.md`)
- Pipeline configs → Progressive alignment: configures (evidence: `README.md`)
- Pipeline configs → Minigraph pangenome: configures (evidence: `README.md`)
- Pipeline configs → Add genome: configures (evidence: `README.md`)
- Pipeline configs → Add outgroup: configures (evidence: `README.md`)
- Pipeline configs → Replace genome: configures (evidence: `README.md`)
- Snakemake → SLURM cluster: submits jobs (evidence: `README.md`)
- Progressive alignment → Cactus tools: runs alignment (evidence: `README.md`)
- Minigraph pangenome → Cactus tools: runs pangenome (evidence: `README.md`)
- Add genome → Cactus tools: updates alignment (evidence: `README.md`)
- Add outgroup → Cactus tools: adds outgroup (evidence: `README.md`)
- Replace genome → Cactus tools: replaces genome (evidence: `README.md`)
- Tree processing → Cactus utilities: imports spacing helper (evidence: `lib/treelib.py`)
- Update preparation → Cactus utilities: imports spacing helper (evidence: `lib/updatelib.py`)
