# cyrussarm/bioforge-genetic-data-analysis-pipeline architecture

> Architecture diagram of the GitHub repository cyrussarm/bioforge-genetic-data-analysis-pipeline, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cyrussarm/bioforge-genetic-data-analysis-pipeline
- Repository: https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline

## Overview

BioForge is a command-line DNA analysis pipeline: a user supplies a FASTA file and filtering options, and receives a report of annotated ORFs that pass those filters. The main workflow loads and validates sequence and reference data, detects complete and incomplete ORFs across six reading frames, translates them into proteins, applies length, weight, and motif filters, assigns IDs, and writes results. The graph also shows logging, biological data files, and model/algorithm layers. Unsampled annotation details and some README-documented capabilities are represented only where the README or source index supports them.

Main entry points: [`main.py`](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/main.py) (Pipeline CLI), [`logger.py`](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/logger.py) (Logging), [`fileLoaders/dataLoader.py`](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/fileLoaders/dataLoader.py) (Biology data loader), [`models/sequence.py`](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/sequence.py) (DNA sequence)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Command and loading"]
  node_main["Pipeline CLI<br/>[main.py]"]
  node_fasta["FASTA loader<br/>[inputLoader.py]"]
  node_reference_data["Biology data loader<br/>[dataLoader.py]"]
  node_codon_table["Codon table<br/>[codon_table.txt]"]
  node_amino_weights["Amino weights<br/>[amino_weights.txt]"]
end

subgraph group_biology["Sequence analysis"]
  node_sequence["DNA sequence<br/>[sequence.py]"]
  node_orf_detection["ORF detection<br/>[ORF_detector.py]"]
  node_orf["ORF model<br/>[ORF.py]"]
  node_translator["Codon translation<br/>[translator.py]"]
  node_protein["Protein model<br/>[protein.py]"]
end

subgraph group_results["Filtering and reporting"]
  node_filtering["Result filters<br/>[filtering.py]"]
  node_annotation["ORF annotation<br/>[annotation.py]"]
  node_report["Report writer<br/>[writeReport.py]"]
  node_report_file["Report file<br/>[report.txt]"]
end

subgraph group_support["Runtime support"]
  node_logger["Logging<br/>[logger.py]"]
  node_exceptions["Custom errors"]
  node_log_file["Execution log"]
end

node_user(("CLI user"))

node_user -->|"runs with options"| node_main
node_main -->|"loads records"| node_fasta
node_main -->|"loads tables"| node_reference_data
node_reference_data -->|"reads"| node_codon_table
node_reference_data -->|"reads"| node_amino_weights
node_main -->|"creates sequences"| node_sequence
node_main -->|"requests ORFs"| node_orf_detection
node_orf_detection -->|"reads sequence"| node_sequence
node_orf_detection -->|"creates ORFs"| node_orf
node_main -->|"translates ORFs"| node_translator
node_translator -->|"sets protein"| node_orf
node_translator -->|"creates protein"| node_protein
node_main -->|"detects motifs"| node_protein
node_main -->|"applies filters"| node_filtering
node_filtering -->|"filters by protein data"| node_orf
node_main -->|"assigns IDs"| node_annotation
node_main -->|"writes results"| node_report
node_report -->|"reads sequence data"| node_sequence
node_report -->|"reads ORF data"| node_orf
node_report -->|"writes report"| node_report_file
node_main -->|"configures logging"| node_logger
node_logger -->|"writes log"| node_log_file
node_fasta -->|"logs events"| node_logger
node_fasta -->|"raises input errors"| node_exceptions
node_reference_data -->|"logs events"| node_logger
node_reference_data -->|"raises data errors"| node_exceptions
node_sequence -->|"logs warnings"| node_logger
node_sequence -->|"raises validation error"| node_exceptions
node_filtering -->|"logs errors"| node_logger
node_filtering -->|"raises filter errors"| node_exceptions

click node_main "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/main.py"
click node_fasta "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/fileLoaders/inputLoader.py"
click node_reference_data "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/fileLoaders/dataLoader.py"
click node_codon_table "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/data/codon_table.txt"
click node_amino_weights "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/data/amino_weights.txt"
click node_sequence "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/sequence.py"
click node_orf_detection "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/ORF_detector.py"
click node_orf "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/ORF.py"
click node_translator "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/translator.py"
click node_protein "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/protein.py"
click node_filtering "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/filtering.py"
click node_annotation "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/annotation.py"
click node_report "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/writeReport.py"
click node_report_file "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/output/report.txt"
click node_logger "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/logger.py"
click node_exceptions "https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/BioForgeExceptions.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_main,node_fasta,node_reference_data,node_codon_table,node_amino_weights,node_user toneBlue
class node_sequence,node_orf_detection,node_orf,node_translator,node_protein toneAmber
class node_filtering,node_annotation,node_report,node_report_file toneMint
class node_logger,node_exceptions,node_log_file toneRose
```

## Components

### Command and loading

- [Pipeline CLI](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/main.py): `main.py`
- [FASTA loader](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/fileLoaders/inputLoader.py): `fileLoaders/inputLoader.py`
- [Biology data loader](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/fileLoaders/dataLoader.py): `fileLoaders/dataLoader.py`
- [Codon table](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/data/codon_table.txt): `data/codon_table.txt`
- [Amino weights](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/data/amino_weights.txt): `data/amino_weights.txt`

### Sequence analysis

- [DNA sequence](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/sequence.py): `models/sequence.py`
- [ORF detection](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/ORF_detector.py): `utils/ORF_detector.py`
- [ORF model](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/ORF.py): `models/ORF.py`
- [Codon translation](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/translator.py): `utils/translator.py`
- [Protein model](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/protein.py): `models/protein.py`

### Filtering and reporting

- [Result filters](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/filtering.py): `utils/filtering.py`
- [ORF annotation](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/annotation.py): `models/annotation.py`
- [Report writer](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/utils/writeReport.py): `utils/writeReport.py`
- [Report file](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/output/report.txt): `output/report.txt`

### Runtime support

- [Logging](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/logger.py): `logger.py`
- [Custom errors](https://github.com/cyrussarm/bioforge-genetic-data-analysis-pipeline/blob/main/models/BioForgeExceptions.py): `models/BioForgeExceptions.py`
- **Execution log**

### Other components

- **CLI user**

## Connections

- CLI user → Pipeline CLI: runs with options (evidence: `README.md`)
- Pipeline CLI → FASTA loader: loads records (evidence: `main.py`)
- Pipeline CLI → Biology data loader: loads tables (evidence: `main.py`)
- Biology data loader → Codon table: reads (evidence: `fileLoaders/dataLoader.py`)
- Biology data loader → Amino weights: reads (evidence: `fileLoaders/dataLoader.py`)
- Pipeline CLI → DNA sequence: creates sequences (evidence: `main.py`)
- Pipeline CLI → ORF detection: requests ORFs (evidence: `main.py`)
- ORF detection → DNA sequence: reads sequence (evidence: `utils/ORF_detector.py`)
- ORF detection → ORF model: creates ORFs (evidence: `utils/ORF_detector.py`)
- Pipeline CLI → Codon translation: translates ORFs (evidence: `main.py`)
- Codon translation → ORF model: sets protein (evidence: `utils/translator.py`)
- Codon translation → Protein model: creates protein (evidence: `utils/translator.py`)
- Pipeline CLI → Protein model: detects motifs (evidence: `main.py`)
- Pipeline CLI → Result filters: applies filters (evidence: `main.py`)
- Result filters → ORF model: filters by protein data (evidence: `utils/filtering.py`)
- Pipeline CLI → ORF annotation: assigns IDs (evidence: `main.py`)
- Pipeline CLI → Report writer: writes results (evidence: `main.py`)
- Report writer → DNA sequence: reads sequence data (evidence: `utils/writeReport.py`)
- Report writer → ORF model: reads ORF data (evidence: `utils/writeReport.py`)
- Report writer → Report file: writes report (evidence: `utils/writeReport.py`)
- Pipeline CLI → Logging: configures logging (evidence: `main.py`)
- Logging → Execution log: writes log (evidence: `logger.py`)
- FASTA loader → Logging: logs events (evidence: `fileLoaders/inputLoader.py`)
- FASTA loader → Custom errors: raises input errors (evidence: `fileLoaders/inputLoader.py`)
- Biology data loader → Logging: logs events (evidence: `fileLoaders/dataLoader.py`)
- Biology data loader → Custom errors: raises data errors (evidence: `fileLoaders/dataLoader.py`)
- DNA sequence → Logging: logs warnings (evidence: `models/sequence.py`)
- DNA sequence → Custom errors: raises validation error (evidence: `models/sequence.py`)
- Result filters → Logging: logs errors (evidence: `utils/filtering.py`)
- Result filters → Custom errors: raises filter errors (evidence: `utils/filtering.py`)
