# redbluee/roomacousticwizard architecture

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

- Interactive diagram: https://gitdiagram.com/redbluee/roomacousticwizard
- Repository: https://github.com/redbluee/roomacousticwizard

## Overview

RoomAcousticWizard is a Dash application for entering room and surface properties, calculating octave-band reverberation times, and comparing results with DIN 18041 requirements. The main path runs from the user through the home-page interface into the acoustic calculation model and then to plotted results. Material data can be selected from a CSV-backed catalogue, and air damping is an optional calculation capability. The calculation and page excerpts are partial, so some documented features are shown without asserting unsampled call details.

Main entry points: [`pages/home.py`](https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py) (Room setup), [`src/reverberation_calc.py`](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py) (Reverberation calculation), [`app.py`](https://github.com/redbluee/roomacousticwizard/blob/main/app.py) (Dash application), [`src/material_database.py`](https://github.com/redbluee/roomacousticwizard/blob/main/src/material_database.py) (Material lookup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["User interface"]
  node_application["Dash application<br/>[app.py]"]
  node_home["Room setup<br/>[home.py]"]
  node_surface_editor["Surface editor<br/>[home.py]"]
  node_results["Results chart<br/>[home.py]"]
end

subgraph group_acoustics["Acoustic model"]
  node_room["Room properties"]
  node_surface["Surface model"]
  node_material["Material model"]
  node_air_damping["Air damping"]
  node_reverberation["Reverberation calculation"]
  node_din_limits["DIN 18041 limits"]
end

subgraph group_reference["Reference data"]
  node_catalogue["Material lookup"]
  node_materials_csv["Material catalogue<br/>[materials.csv]"]
end

node_user(("Room designer"))

node_user -->|"opens"| node_application
node_application -->|"hosts page"| node_home
node_user -->|"enters room data"| node_home
node_user -->|"defines surfaces"| node_surface_editor
node_surface_editor -->|"creates materials"| node_material
node_surface_editor -->|"creates surfaces"| node_surface
node_home -.->|"provides room data"| node_room
node_room -->|"supplies properties"| node_reverberation
node_surface -->|"supplies surfaces"| node_reverberation
node_reverberation -.->|"uses optionally"| node_air_damping
node_home -.->|"calculates"| node_reverberation
node_home -.->|"selects requirements"| node_din_limits
node_reverberation -.->|"plots results"| node_results
node_din_limits -.->|"plots limits"| node_results
node_home -.->|"offers lookup"| node_catalogue
node_catalogue -->|"reads"| node_materials_csv
node_home -->|"loads catalogue"| node_materials_csv

click node_application "https://github.com/redbluee/roomacousticwizard/blob/main/app.py"
click node_home "https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py"
click node_surface_editor "https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py"
click node_results "https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py"
click node_room "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_surface "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_material "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_air_damping "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_reverberation "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_din_limits "https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py"
click node_catalogue "https://github.com/redbluee/roomacousticwizard/blob/main/src/material_database.py"
click node_materials_csv "https://github.com/redbluee/roomacousticwizard/blob/main/materials.csv"

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_application,node_home,node_surface_editor,node_results toneBlue
class node_room,node_surface,node_material,node_air_damping,node_reverberation,node_din_limits toneAmber
class node_catalogue,node_materials_csv toneMint
class node_user toneIndigo
```

## Components

### User interface

- [Dash application](https://github.com/redbluee/roomacousticwizard/blob/main/app.py): `app.py`
- [Room setup](https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py): `pages/home.py`
- [Surface editor](https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py): `pages/home.py`
- [Results chart](https://github.com/redbluee/roomacousticwizard/blob/main/pages/home.py): `pages/home.py`

### Acoustic model

- [Room properties](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`
- [Surface model](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`
- [Material model](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`
- [Air damping](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`
- [Reverberation calculation](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`
- [DIN 18041 limits](https://github.com/redbluee/roomacousticwizard/blob/main/src/reverberation_calc.py): `src/reverberation_calc.py`

### Reference data

- [Material lookup](https://github.com/redbluee/roomacousticwizard/blob/main/src/material_database.py): `src/material_database.py`
- [Material catalogue](https://github.com/redbluee/roomacousticwizard/blob/main/materials.csv): `materials.csv`

### Other components

- **Room designer**

## Connections

- Room designer → Dash application: opens (evidence: `README.md`)
- Dash application → Room setup: hosts page (evidence: `app.py`)
- Room designer → Room setup: enters room data (evidence: `README.md`)
- Room designer → Surface editor: defines surfaces (evidence: `README.md`)
- Surface editor → Material model: creates materials (evidence: `pages/home.py`)
- Surface editor → Surface model: creates surfaces (evidence: `pages/home.py`)
- Room setup → Room properties: provides room data (evidence: `pages/home.py`)
- Room properties → Reverberation calculation: supplies properties (evidence: `src/reverberation_calc.py`)
- Surface model → Reverberation calculation: supplies surfaces (evidence: `src/reverberation_calc.py`)
- Reverberation calculation → Air damping: uses optionally (evidence: `src/reverberation_calc.py`)
- Room setup → Reverberation calculation: calculates (evidence: `pages/home.py`)
- Room setup → DIN 18041 limits: selects requirements (evidence: `pages/home.py`)
- Reverberation calculation → Results chart: plots results (evidence: `pages/home.py`)
- DIN 18041 limits → Results chart: plots limits (evidence: `pages/home.py`)
- Room setup → Material lookup: offers lookup
- Material lookup → Material catalogue: reads (evidence: `src/material_database.py`)
- Room setup → Material catalogue: loads catalogue (evidence: `pages/home.py`)
