# yvanrousset/fckcat architecture

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

- Interactive diagram: https://gitdiagram.com/yvanrousset/fckcat
- Repository: https://github.com/yvanrousset/fckcat

## Overview

FCKcat is a research-analysis repository for studying and predicting enzyme kcat fold-changes, not a deployed prediction service. The documented workflow is to obtain the analysis data and model archive from Zenodo, then run four notebooks for bias analysis, FCKcat test-pair predictions, baseline comparisons, and model selection/ablations. Shared preprocessing and plotting utilities live in notebooks/utils/helpers.py. Notebook internals and their calls to the helper module were not sampled, so those relationships are not asserted.

Main entry points: [`notebooks/nb1_bias_analysis.ipynb`](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb1_bias_analysis.ipynb) (Bias analysis), [`notebooks/nb2_model_predictions.ipynb`](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb2_model_predictions.ipynb) (FCKcat predictions), [`notebooks/nb3_model_comparison.ipynb`](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb3_model_comparison.ipynb) (Baseline comparison), [`notebooks/nb4_model_selection.ipynb`](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb4_model_selection.ipynb) (Model selection)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_analysis["Research analyses"]
  node_bias["Bias analysis"]
  node_predictions["FCKcat predictions"]
  node_comparison["Baseline comparison"]
  node_selection["Model selection"]
end

subgraph group_shared["Shared utilities"]
  node_helpers["Preprocessing and plots<br/>[helpers.py]"]
end

node_researcher(("Researcher"))
node_zenodo["Zenodo archive"]

node_researcher -->|"runs analysis"| node_bias
node_researcher -->|"runs predictions"| node_predictions
node_researcher -->|"runs comparison"| node_comparison
node_researcher -->|"runs selection"| node_selection
node_zenodo -->|"provides data"| node_bias
node_zenodo -->|"provides data"| node_predictions
node_zenodo -->|"provides data"| node_comparison
node_zenodo -->|"provides data"| node_selection

click node_bias "https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb1_bias_analysis.ipynb"
click node_predictions "https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb2_model_predictions.ipynb"
click node_comparison "https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb3_model_comparison.ipynb"
click node_selection "https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb4_model_selection.ipynb"
click node_helpers "https://github.com/yvanrousset/fckcat/blob/main/notebooks/utils/helpers.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_bias,node_predictions,node_comparison,node_selection toneBlue
class node_helpers toneAmber
class node_researcher,node_zenodo toneIndigo
```

## Components

### Research analyses

- [Bias analysis](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb1_bias_analysis.ipynb): `notebooks/nb1_bias_analysis.ipynb`
- [FCKcat predictions](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb2_model_predictions.ipynb): `notebooks/nb2_model_predictions.ipynb`
- [Baseline comparison](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb3_model_comparison.ipynb): `notebooks/nb3_model_comparison.ipynb`
- [Model selection](https://github.com/yvanrousset/fckcat/blob/main/notebooks/nb4_model_selection.ipynb): `notebooks/nb4_model_selection.ipynb`

### Shared utilities

- [Preprocessing and plots](https://github.com/yvanrousset/fckcat/blob/main/notebooks/utils/helpers.py): `notebooks/utils/helpers.py`

### Other components

- **Researcher**
- **Zenodo archive**

## Connections

- Researcher → Bias analysis: runs analysis (evidence: `README.md`)
- Researcher → FCKcat predictions: runs predictions (evidence: `README.md`)
- Researcher → Baseline comparison: runs comparison (evidence: `README.md`)
- Researcher → Model selection: runs selection (evidence: `README.md`)
- Zenodo archive → Bias analysis: provides data (evidence: `README.md`)
- Zenodo archive → FCKcat predictions: provides data (evidence: `README.md`)
- Zenodo archive → Baseline comparison: provides data (evidence: `README.md`)
- Zenodo archive → Model selection: provides data (evidence: `README.md`)
