# deam0on/b_e_a_s_t architecture

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

- Interactive diagram: https://gitdiagram.com/deam0on/b_e_a_s_t
- Repository: https://github.com/deam0on/b_e_a_s_t

## Overview

BEAST is a command-line and Colab-compatible tool for fitting NMR titration data to host–guest binding models and evaluating fit quality. Its principal workflow is CSV input, configured model fitting, residual diagnostics and model comparison, then tabular and plotted results. The sampled CLI calls the analysis entry point and result-cleanup helper; the analysis module imports the model definitions and utilities. The README documents major capabilities whose internal call paths were not sampled, so those links are omitted rather than inferred.

Main entry points: [`binding_analysis/analysis.py`](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py) (Curve fitting), [`binding_analysis/binding_analysis_tool.py`](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/binding_analysis_tool.py) (CLI and config), [`binding_analysis/utils.py`](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py) (CSV results), [`binding_analysis/models.py`](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/models.py) (Binding models)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry"]
  node_cli["CLI and config"]
  node_input["Titration CSVs"]
end

subgraph group_analysis["Analysis"]
  node_input_validation["Input validation<br/>[utils.py]"]
  node_fit["Curve fitting<br/>[analysis.py]"]
  node_models["Binding models<br/>[models.py]"]
  node_initial_guess["Initial guesses<br/>[utils.py]"]
  node_diagnostics["Fit diagnostics<br/>[analysis.py]"]
  node_residual_tests["Residual tests<br/>[utils.py]"]
  node_comparison["Model comparison<br/>[analysis.py]"]
end

subgraph group_results["Results"]
  node_plots["Fit and residual plots<br/>[analysis.py]"]
  node_csv_results["CSV results<br/>[utils.py]"]
  node_logs["Run logs"]
  node_output["Results directory"]
end

node_researcher(("Researcher"))

node_researcher -->|"runs"| node_cli
node_cli -->|"invokes"| node_fit
node_input -->|"analyzed as"| node_fit
node_fit -->|"fits against"| node_models
node_fit -->|"refines guesses"| node_initial_guess
node_fit -->|"evaluates fit"| node_diagnostics
node_diagnostics -->|"runs tests"| node_residual_tests
node_fit -->|"ranks models"| node_comparison
node_fit -->|"generates"| node_plots
node_fit -->|"saves results"| node_csv_results
node_cli -->|"cleans old results"| node_output
node_plots -->|"writes PNGs"| node_output
node_csv_results -->|"writes CSVs"| node_output
node_cli -->|"configures"| node_logs
node_logs -->|"writes log"| node_output

click node_cli "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/binding_analysis_tool.py"
click node_input_validation "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py"
click node_fit "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py"
click node_models "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/models.py"
click node_initial_guess "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py"
click node_diagnostics "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py"
click node_residual_tests "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py"
click node_comparison "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py"
click node_plots "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py"
click node_csv_results "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py"
click node_logs "https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/binding_analysis_tool.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_cli,node_input toneBlue
class node_input_validation,node_fit,node_models,node_initial_guess,node_diagnostics,node_residual_tests,node_comparison toneAmber
class node_plots,node_csv_results,node_logs,node_output toneMint
class node_researcher toneIndigo
```

## Components

### User entry

- [CLI and config](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/binding_analysis_tool.py): `binding_analysis/binding_analysis_tool.py`
- **Titration CSVs**

### Analysis

- [Input validation](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py): `binding_analysis/utils.py`
- [Curve fitting](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py): `binding_analysis/analysis.py`
- [Binding models](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/models.py): `binding_analysis/models.py`
- [Initial guesses](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py): `binding_analysis/utils.py`
- [Fit diagnostics](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py): `binding_analysis/analysis.py`
- [Residual tests](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py): `binding_analysis/utils.py`
- [Model comparison](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py): `binding_analysis/analysis.py`

### Results

- [Fit and residual plots](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/analysis.py): `binding_analysis/analysis.py`
- [CSV results](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/utils.py): `binding_analysis/utils.py`
- [Run logs](https://github.com/deam0on/b_e_a_s_t/blob/master/binding_analysis/binding_analysis_tool.py): `binding_analysis/binding_analysis_tool.py`
- **Results directory**

### Other components

- **Researcher**

## Connections

- Researcher → CLI and config: runs (evidence: `README.md`)
- CLI and config → Curve fitting: invokes (evidence: `binding_analysis/binding_analysis_tool.py`)
- Titration CSVs → Curve fitting: analyzed as (evidence: `README.md`)
- Curve fitting → Binding models: fits against (evidence: `binding_analysis/analysis.py`)
- Curve fitting → Initial guesses: refines guesses (evidence: `binding_analysis/analysis.py`)
- Curve fitting → Fit diagnostics: evaluates fit (evidence: `README.md`)
- Fit diagnostics → Residual tests: runs tests (evidence: `README.md`)
- Curve fitting → Model comparison: ranks models (evidence: `binding_analysis/analysis.py`)
- Curve fitting → Fit and residual plots: generates (evidence: `README.md`)
- Curve fitting → CSV results: saves results (evidence: `README.md`)
- CLI and config → Results directory: cleans old results (evidence: `binding_analysis/binding_analysis_tool.py`)
- Fit and residual plots → Results directory: writes PNGs (evidence: `README.md`)
- CSV results → Results directory: writes CSVs (evidence: `README.md`)
- CLI and config → Run logs: configures (evidence: `binding_analysis/binding_analysis_tool.py`)
- Run logs → Results directory: writes log (evidence: `README.md`)
