# bio-brillouin/hdf5_bls architecture

> Architecture diagram of the GitHub repository bio-brillouin/hdf5_bls, 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/bio-brillouin/hdf5_bls
- Repository: https://github.com/bio-brillouin/hdf5_bls

## Overview

HDF5_BLS is a BLS data workflow: load or convert raw measurements, store raw data and power spectra in a structured HDF5 file, analyze spectra, and treat them into scientific quantities. The Python packages also expose algorithm authoring and a GUI for file and processing workflows. The README documents the package capabilities; sampled source and the SOURCE INDEX support only some cross-component links, so uncertain integration paths are omitted.

Main entry points: [`packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_data.py) (Format dispatch), [`packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py`](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py) (HDF5 wrapper), [`packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py`](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py) (Spectrum treatment), [`packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py`](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py) (VIPA analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ingest["Data ingestion"]
  node_load_dispatch["Format dispatch<br/>[load_data.py]"]
  node_dat_loader["DAT loader<br/>[load_dat.py]"]
  node_sif_loader["SIF loader<br/>[load_sif.py]"]
  node_image_loader["Image loader<br/>[load_image.py]"]
  node_npy_loader["NumPy loader<br/>[load_npy.py]"]
  node_brim_converter["Brim converter<br/>[brim_converter.py]"]
  node_hdf5_flattener["HDF5 flattener<br/>[hdf5_flattener.py]"]
end

subgraph group_storage["HDF5 storage"]
  node_wrapper["HDF5 wrapper<br/>[wrapper.py]"]
  node_hdf5_store[("HDF5 file")]
  node_psd_conversion["PSD conversion<br/>[conversion_PSD.py]"]
end

subgraph group_analysis["Spectrum analysis"]
  node_analyse_vipa["VIPA analysis<br/>[VIPA.py]"]
  node_analyse_general["Analysis utilities<br/>[general.py]"]
  node_analyse_backend["Analysis algorithms<br/>[analyse_backend.py]"]
end

subgraph group_treatment["Data treatment"]
  node_treat["Spectrum treatment<br/>[treat.py]"]
  node_treat_backend["Treatment algorithms<br/>[treat_backend.py]"]
  node_treat_models["Fit models<br/>[models.py]"]
end

subgraph group_interface["User interface"]
  node_gui_app["GUI application<br/>[app.py]"]
  node_main_window["File workspace<br/>[main.py]"]
  node_data_processing["Processing dialogs<br/>[main.py]"]
  node_choice_dialog["Choice dialog<br/>[main.py]"]
end

node_user(("Researcher"))
node_file_sources["Raw data files"]

node_user -->|"requests loading"| node_load_dispatch
node_file_sources -.->|"provides files"| node_load_dispatch
node_load_dispatch -->|"dispatches DAT"| node_dat_loader
node_load_dispatch -->|"dispatches SIF"| node_sif_loader
node_load_dispatch -->|"dispatches images"| node_image_loader
node_load_dispatch -->|"dispatches NumPy"| node_npy_loader
node_dat_loader -.->|"returns loaded data"| node_wrapper
node_sif_loader -.->|"returns loaded data"| node_wrapper
node_brim_converter -->|"writes converted data"| node_hdf5_store
node_brim_converter -->|"uses flattener"| node_hdf5_flattener
node_wrapper -->|"reads and writes"| node_hdf5_store
node_wrapper -->|"loads source data"| node_load_dispatch
node_wrapper -.->|"converts spectra"| node_psd_conversion
node_user -->|"defines analysis"| node_analyse_vipa
node_analyse_vipa -->|"uses utilities"| node_analyse_general
node_analyse_vipa -.->|"inherits workflow"| node_analyse_backend
node_user -->|"defines treatment"| node_treat
node_treat -->|"inherits workflow"| node_treat_backend
node_treat -.->|"uses fit models"| node_treat_models
node_treat -->|"stores results"| node_wrapper
node_gui_app -->|"opens window"| node_main_window
node_main_window -->|"opens processing"| node_data_processing
node_main_window -->|"uses dialog"| node_choice_dialog
node_data_processing -->|"uses dialog"| node_choice_dialog
node_user -.->|"uses GUI"| node_gui_app

click node_load_dispatch "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_data.py"
click node_dat_loader "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_dat.py"
click node_sif_loader "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_sif.py"
click node_image_loader "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_image.py"
click node_npy_loader "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_npy.py"
click node_brim_converter "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/brim_converter.py"
click node_hdf5_flattener "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/hdf5_flattener.py"
click node_wrapper "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py"
click node_psd_conversion "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/conversion_PSD.py"
click node_analyse_vipa "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py"
click node_analyse_general "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/general.py"
click node_analyse_backend "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/analyse_backend.py"
click node_treat "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py"
click node_treat_backend "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat_backend.py"
click node_treat_models "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/models.py"
click node_gui_app "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/app.py"
click node_main_window "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/Main/main.py"
click node_data_processing "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/DataProcessing/main.py"
click node_choice_dialog "https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/MessageBox_multiple_choice/main.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_dispatch,node_dat_loader,node_sif_loader,node_image_loader,node_npy_loader,node_brim_converter,node_hdf5_flattener toneBlue
class node_wrapper,node_hdf5_store,node_psd_conversion toneAmber
class node_analyse_vipa,node_analyse_general,node_analyse_backend toneMint
class node_treat,node_treat_backend,node_treat_models toneRose
class node_gui_app,node_main_window,node_data_processing,node_choice_dialog,node_user,node_file_sources toneIndigo
```

## Components

### Data ingestion

- [Format dispatch](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_data.py): `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`
- [DAT loader](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_dat.py): `packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_dat.py`
- [SIF loader](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_sif.py): `packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_sif.py`
- [Image loader](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_image.py): `packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_image.py`
- [NumPy loader](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_npy.py): `packages/HDF5_BLS/src/_HDF5_BLS/load_formats/load_npy.py`
- [Brim converter](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/brim_converter.py): `packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/brim_converter.py`
- [HDF5 flattener](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/hdf5_flattener.py): `packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/hdf5_flattener.py`

### HDF5 storage

- [HDF5 wrapper](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py): `packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py`
- **HDF5 file**
- [PSD conversion](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS/src/_HDF5_BLS/conversion_PSD.py): `packages/HDF5_BLS/src/_HDF5_BLS/conversion_PSD.py`

### Spectrum analysis

- [VIPA analysis](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py): `packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py`
- [Analysis utilities](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/general.py): `packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/general.py`
- [Analysis algorithms](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/analyse_backend.py): `packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/analyse_backend.py`

### Data treatment

- [Spectrum treatment](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py): `packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py`
- [Treatment algorithms](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat_backend.py): `packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat_backend.py`
- [Fit models](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/models.py): `packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/models.py`

### User interface

- [GUI application](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/app.py): `packages/HDF5_BLS_GUI/src/app.py`
- [File workspace](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/Main/main.py): `packages/HDF5_BLS_GUI/src/Main/main.py`
- [Processing dialogs](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/DataProcessing/main.py): `packages/HDF5_BLS_GUI/src/DataProcessing/main.py`
- [Choice dialog](https://github.com/bio-brillouin/hdf5_bls/blob/main/packages/HDF5_BLS_GUI/src/MessageBox_multiple_choice/main.py): `packages/HDF5_BLS_GUI/src/MessageBox_multiple_choice/main.py`

### Other components

- **Researcher**
- **Raw data files**

## Connections

- Researcher → Format dispatch: requests loading (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`)
- Raw data files → Format dispatch: provides files
- Format dispatch → DAT loader: dispatches DAT (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`)
- Format dispatch → SIF loader: dispatches SIF (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`)
- Format dispatch → Image loader: dispatches images (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`)
- Format dispatch → NumPy loader: dispatches NumPy (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/load_data.py`)
- DAT loader → HDF5 wrapper: returns loaded data
- SIF loader → HDF5 wrapper: returns loaded data
- Brim converter → HDF5 file: writes converted data (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/brim_converter.py`)
- Brim converter → HDF5 flattener: uses flattener (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/brimfile_converter/brim_converter.py`)
- HDF5 wrapper → HDF5 file: reads and writes
- HDF5 wrapper → Format dispatch: loads source data (evidence: `packages/HDF5_BLS/src/_HDF5_BLS/wrapper.py`)
- HDF5 wrapper → PSD conversion: converts spectra
- Researcher → VIPA analysis: defines analysis
- VIPA analysis → Analysis utilities: uses utilities (evidence: `packages/HDF5_BLS_analyse/src/_HDF5_BLS_analyse/VIPA.py`)
- VIPA analysis → Analysis algorithms: inherits workflow
- Researcher → Spectrum treatment: defines treatment
- Spectrum treatment → Treatment algorithms: inherits workflow (evidence: `packages/HDF5_BLS_treat/src/_HDF5_BLS_treat/treat.py`)
- Spectrum treatment → Fit models: uses fit models
- Spectrum treatment → HDF5 wrapper: stores results
- GUI application → File workspace: opens window (evidence: `packages/HDF5_BLS_GUI/src/app.py`)
- File workspace → Processing dialogs: opens processing (evidence: `packages/HDF5_BLS_GUI/src/Main/main.py`)
- File workspace → Choice dialog: uses dialog (evidence: `packages/HDF5_BLS_GUI/src/Main/main.py`)
- Processing dialogs → Choice dialog: uses dialog (evidence: `packages/HDF5_BLS_GUI/src/DataProcessing/main.py`)
- Researcher → GUI application: uses GUI
