# barahona-research-group/ramanspy architecture

> Architecture diagram of the GitHub repository barahona-research-group/ramanspy, 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/barahona-research-group/ramanspy
- Repository: https://github.com/barahona-research-group/ramanspy

## Overview

RamanSPy is a Python toolkit for Raman spectroscopy analytics. Its main workflow loads instrument data into common spectral containers, preprocesses it, applies analysis such as spectral unmixing, and visualizes the results. Separate capabilities include datasets, preprocessing protocols, metrics, and synthetic-data generation. The graph reflects README-described workflow and SOURCE INDEX references; unsampled modules are represented by their indexed paths, without assuming undocumented calls.

Main entry points: [`src/ramanspy/preprocessing/protocols.py`](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/protocols.py) (Preprocessing protocols), [`src/ramanspy/core.py`](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/core.py) (Spectral containers), [`src/ramanspy/analysis/Step.py`](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/Step.py) (Analysis step), [`src/ramanspy/plot/plot.py`](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/plot/plot.py) (Visualization)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ingest["Data and containers"]
  node_load["Instrument loaders<br/>[load.py]"]
  node_container["Spectral containers<br/>[core.py]"]
  node_datasets["Raman datasets<br/>[datasets.py]"]
end

subgraph group_prep["Preprocessing"]
  node_pipeline["Pipeline runner<br/>[Pipeline.py]"]
  node_prepstep["Preprocessing step<br/>[Step.py]"]
  node_baseline["Baseline correction<br/>[baseline.py]"]
  node_denoise["Denoising<br/>[denoise.py]"]
  node_despike["Cosmic ray removal<br/>[despike.py]"]
  node_misc["Crop and background<br/>[misc.py]"]
  node_normalise["Normalization<br/>[normalise.py]"]
  node_protocols["Preprocessing protocols<br/>[protocols.py]"]
end

subgraph group_analysis["Analysis"]
  node_analysisstep["Analysis step<br/>[Step.py]"]
  node_unmix["Spectral unmixing<br/>[unmix.py]"]
  node_decompose["Decomposition<br/>[decompose.py]"]
  node_cluster["Clustering<br/>[cluster.py]"]
end

subgraph group_outputs["Visualization and outputs"]
  node_plot["Visualization<br/>[plot.py]"]
  node_plotcore["Plot primitives<br/>[_core.py]"]
end

subgraph group_support["Supporting capabilities"]
  node_metrics["Analysis metrics<br/>[metrics.py]"]
  node_synth["Synthetic data<br/>[synth.py]"]
end

node_user(("Python user"))

node_user -->|"loads data"| node_load
node_load -->|"creates containers"| node_container
node_user -->|"preprocesses"| node_pipeline
node_pipeline -->|"applies sequentially"| node_prepstep
node_protocols -->|"builds pipelines"| node_pipeline
node_protocols -->|"configures"| node_baseline
node_protocols -->|"configures"| node_denoise
node_protocols -->|"configures"| node_despike
node_protocols -->|"configures"| node_misc
node_protocols -->|"configures"| node_normalise
node_user -->|"requests analysis"| node_unmix
node_unmix -->|"uses framework"| node_analysisstep
node_decompose -->|"uses framework"| node_analysisstep
node_cluster -->|"uses framework"| node_analysisstep
node_analysisstep -->|"flattens and refolds"| node_container
node_user -->|"visualizes results"| node_plot
node_plot -->|"uses primitives"| node_plotcore
node_plot -->|"plots spectral data"| node_container
node_datasets -->|"creates containers"| node_container
node_synth -->|"creates spectra"| node_container
node_metrics -->|"accepts spectral data"| node_container

click node_load "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/load.py"
click node_container "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/core.py"
click node_datasets "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/datasets.py"
click node_pipeline "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/Pipeline.py"
click node_prepstep "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/Step.py"
click node_baseline "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/baseline.py"
click node_denoise "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/denoise.py"
click node_despike "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/despike.py"
click node_misc "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/misc.py"
click node_normalise "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/normalise.py"
click node_protocols "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/protocols.py"
click node_analysisstep "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/Step.py"
click node_unmix "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/unmix.py"
click node_decompose "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/decompose.py"
click node_cluster "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/cluster.py"
click node_plot "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/plot/plot.py"
click node_plotcore "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/plot/_core.py"
click node_metrics "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/metrics.py"
click node_synth "https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/synth/synth.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_load,node_container,node_datasets,node_user toneBlue
class node_pipeline,node_prepstep,node_baseline,node_denoise,node_despike,node_misc,node_normalise,node_protocols toneAmber
class node_analysisstep,node_unmix,node_decompose,node_cluster toneMint
class node_plot,node_plotcore toneRose
class node_metrics,node_synth toneIndigo
```

## Components

### Data and containers

- [Instrument loaders](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/load.py): `src/ramanspy/load.py`
- [Spectral containers](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/core.py): `src/ramanspy/core.py`
- [Raman datasets](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/datasets.py): `src/ramanspy/datasets.py`

### Preprocessing

- [Pipeline runner](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/Pipeline.py): `src/ramanspy/preprocessing/Pipeline.py`
- [Preprocessing step](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/Step.py): `src/ramanspy/preprocessing/Step.py`
- [Baseline correction](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/baseline.py): `src/ramanspy/preprocessing/baseline.py`
- [Denoising](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/denoise.py): `src/ramanspy/preprocessing/denoise.py`
- [Cosmic ray removal](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/despike.py): `src/ramanspy/preprocessing/despike.py`
- [Crop and background](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/misc.py): `src/ramanspy/preprocessing/misc.py`
- [Normalization](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/normalise.py): `src/ramanspy/preprocessing/normalise.py`
- [Preprocessing protocols](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/preprocessing/protocols.py): `src/ramanspy/preprocessing/protocols.py`

### Analysis

- [Analysis step](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/Step.py): `src/ramanspy/analysis/Step.py`
- [Spectral unmixing](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/unmix.py): `src/ramanspy/analysis/unmix.py`
- [Decomposition](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/decompose.py): `src/ramanspy/analysis/decompose.py`
- [Clustering](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/analysis/cluster.py): `src/ramanspy/analysis/cluster.py`

### Visualization and outputs

- [Visualization](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/plot/plot.py): `src/ramanspy/plot/plot.py`
- [Plot primitives](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/plot/_core.py): `src/ramanspy/plot/_core.py`

### Supporting capabilities

- [Analysis metrics](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/metrics.py): `src/ramanspy/metrics.py`
- [Synthetic data](https://github.com/barahona-research-group/ramanspy/blob/main/src/ramanspy/synth/synth.py): `src/ramanspy/synth/synth.py`

### Other components

- **Python user**

## Connections

- Python user → Instrument loaders: loads data (evidence: `README.md`)
- Instrument loaders → Spectral containers: creates containers (evidence: `src/ramanspy/load.py`)
- Python user → Pipeline runner: preprocesses (evidence: `README.md`)
- Pipeline runner → Preprocessing step: applies sequentially (evidence: `src/ramanspy/preprocessing/Pipeline.py`)
- Preprocessing protocols → Pipeline runner: builds pipelines (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Preprocessing protocols → Baseline correction: configures (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Preprocessing protocols → Denoising: configures (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Preprocessing protocols → Cosmic ray removal: configures (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Preprocessing protocols → Crop and background: configures (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Preprocessing protocols → Normalization: configures (evidence: `src/ramanspy/preprocessing/protocols.py`)
- Python user → Spectral unmixing: requests analysis (evidence: `README.md`)
- Spectral unmixing → Analysis step: uses framework (evidence: `src/ramanspy/analysis/unmix.py`)
- Decomposition → Analysis step: uses framework (evidence: `src/ramanspy/analysis/decompose.py`)
- Clustering → Analysis step: uses framework (evidence: `src/ramanspy/analysis/cluster.py`)
- Analysis step → Spectral containers: flattens and refolds (evidence: `src/ramanspy/analysis/Step.py`)
- Python user → Visualization: visualizes results (evidence: `README.md`)
- Visualization → Plot primitives: uses primitives (evidence: `src/ramanspy/plot/plot.py`)
- Visualization → Spectral containers: plots spectral data (evidence: `src/ramanspy/plot/plot.py`)
- Raman datasets → Spectral containers: creates containers (evidence: `src/ramanspy/datasets.py`)
- Synthetic data → Spectral containers: creates spectra (evidence: `src/ramanspy/synth/synth.py`)
- Analysis metrics → Spectral containers: accepts spectral data (evidence: `src/ramanspy/metrics.py`)
