# fishyishyfishy/pyrpoc architecture

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

- Interactive diagram: https://gitdiagram.com/fishyishyfishy/pyrpoc
- Repository: https://github.com/fishyishyfishy/pyrpoc

## Overview

pyrpoc is a desktop instrument-control workbench for configuring devices, running acquisition programs, and inspecting or saving their datasets. The principal workflow is: launch the application, select and configure a program and its devices, execute a run, publish frames into datasets, then view or save the results. The graph also preserves the plugin-based program/device model and the shared parameter and data contracts. Several subsystem details are represented by their source directories because their implementations were not sampled; edges are limited to documented wiring and SOURCE INDEX references.

Main entry points: [`pyrpoc/app/application.py`](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/app/application.py) (Application state), [`pyrpoc/acquisition/executor.py`](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/executor.py) (Run executor), [`pyrpoc/structs/plugins/programs/program.py`](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/programs/program.py) (Program contract), [`pyrpoc/plugins/programs`](https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/programs) (Acquisition programs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application"]
  node_main["Application launch<br/>[main.py]"]
  node_application["Application state<br/>[application.py]"]
  node_window["Workbench window<br/>[window.py]"]
end

subgraph group_acq["Acquisition"]
  node_acquisition["Acquisition setup<br/>[model.py]"]
  node_acquisition_ui["Acquisition controls<br/>[panel.py]"]
  node_executor["Run executor<br/>[executor.py]"]
end

subgraph group_plugins["Programs and devices"]
  node_inventory["Device inventory<br/>[inventory.py]"]
  node_device_drivers["Instrument drivers"]
  node_programs["Acquisition programs"]
  node_run_loops["Run-loop helpers<br/>[run_loops.py]"]
  node_galvo_raster["Galvo raster<br/>[galvo_raster.py]"]
  node_parameters["Parameter blocks"]
  node_data_panel_plugins["Data display plugins"]
end

subgraph group_data["Data library"]
  node_library_model["Library model<br/>[model.py]"]
  node_library_store[("Dataset store<br/>[store.py]")]
  node_library_panel["Data library view<br/>[panel.py]"]
  node_dataset[("Dataset frames<br/>[dataset.py]")]
  node_saving["Recording writers<br/>[saving.py]"]
end

subgraph group_contracts["Shared contracts"]
  node_data_kinds["Data kinds<br/>[data.py]"]
  node_plugin_registry["Plugin registry<br/>[registry.py]"]
  node_device_contract["Device contract<br/>[devices.py]"]
  node_program_contract["Program contract<br/>[program.py]"]
  node_parameter_contract["Parameter model<br/>[params.py]"]
end

node_user(("Workbench user"))

node_user -->|"launches"| node_main
node_main -->|"creates"| node_application
node_main -->|"opens"| node_window
node_application -->|"creates"| node_inventory
node_application -->|"creates"| node_library_model
node_application -->|"creates"| node_library_store
node_application -->|"creates"| node_acquisition
node_application -->|"loads plugins"| node_plugin_registry
node_acquisition_ui -->|"edits"| node_acquisition
node_acquisition -.->|"starts runs"| node_executor
node_executor -->|"uses program API"| node_program_contract
node_executor -->|"resolves devices"| node_device_contract
node_executor -->|"creates outputs"| node_dataset
node_executor -->|"configures recording"| node_saving
node_executor -->|"updates store"| node_library_store
node_programs -->|"implements"| node_program_contract
node_programs -->|"calls helpers"| node_run_loops
node_programs -->|"declares blocks"| node_parameters
node_programs -->|"calls raster"| node_galvo_raster
node_run_loops -->|"uses run context"| node_program_contract
node_run_loops -->|"reads mosaic settings"| node_parameters
node_device_drivers -->|"implements"| node_device_contract
node_inventory -->|"manages devices"| node_device_contract
node_library_model -->|"uses store"| node_library_store
node_library_panel -->|"reads library"| node_library_model
node_library_panel -->|"selects renderers"| node_data_panel_plugins
node_dataset -->|"validates frames"| node_data_kinds
node_dataset -->|"writes frames"| node_saving
node_program_contract -->|"publishes outputs"| node_dataset
node_program_contract -->|"declares requirements"| node_device_contract
node_parameter_contract -->|"registers blocks"| node_plugin_registry
node_data_panel_plugins -.->|"renders data kinds"| node_data_kinds

click node_main "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/main.py"
click node_application "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/app/application.py"
click node_window "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/app/window.py"
click node_inventory "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/device_inventory/inventory.py"
click node_device_drivers "https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/devices"
click node_acquisition "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/model.py"
click node_acquisition_ui "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/panel.py"
click node_executor "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/executor.py"
click node_programs "https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/programs"
click node_run_loops "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/plugins/programs/building_blocks/functions/run_loops.py"
click node_galvo_raster "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/plugins/programs/building_blocks/functions/galvo_raster.py"
click node_parameters "https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/programs/building_blocks/parameter_groups"
click node_library_model "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/model.py"
click node_library_store "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/store.py"
click node_library_panel "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/panel.py"
click node_dataset "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/dataset.py"
click node_saving "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/saving.py"
click node_data_kinds "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/data.py"
click node_plugin_registry "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/registry.py"
click node_device_contract "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/devices.py"
click node_program_contract "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/programs/program.py"
click node_parameter_contract "https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/params.py"
click node_data_panel_plugins "https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/data_panels"

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_main,node_application,node_window,node_user toneBlue
class node_acquisition,node_acquisition_ui,node_executor toneAmber
class node_inventory,node_device_drivers,node_programs,node_run_loops,node_galvo_raster,node_parameters,node_data_panel_plugins toneMint
class node_library_model,node_library_store,node_library_panel,node_dataset,node_saving toneRose
class node_data_kinds,node_plugin_registry,node_device_contract,node_program_contract,node_parameter_contract toneIndigo
```

## Components

### Application

- [Application launch](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/main.py): `pyrpoc/main.py`
- [Application state](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/app/application.py): `pyrpoc/app/application.py`
- [Workbench window](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/app/window.py): `pyrpoc/app/window.py`

### Acquisition

- [Acquisition setup](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/model.py): `pyrpoc/acquisition/model.py`
- [Acquisition controls](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/panel.py): `pyrpoc/acquisition/panel.py`
- [Run executor](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/acquisition/executor.py): `pyrpoc/acquisition/executor.py`

### Programs and devices

- [Device inventory](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/device_inventory/inventory.py): `pyrpoc/device_inventory/inventory.py`
- [Instrument drivers](https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/devices): `pyrpoc/plugins/devices`
- [Acquisition programs](https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/programs): `pyrpoc/plugins/programs`
- [Run-loop helpers](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/plugins/programs/building_blocks/functions/run_loops.py): `pyrpoc/plugins/programs/building_blocks/functions/run_loops.py`
- [Galvo raster](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/plugins/programs/building_blocks/functions/galvo_raster.py): `pyrpoc/plugins/programs/building_blocks/functions/galvo_raster.py`
- [Parameter blocks](https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/programs/building_blocks/parameter_groups): `pyrpoc/plugins/programs/building_blocks/parameter_groups`
- [Data display plugins](https://github.com/fishyishyfishy/pyrpoc/tree/main/pyrpoc/plugins/data_panels): `pyrpoc/plugins/data_panels`

### Data library

- [Library model](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/model.py): `pyrpoc/data_library/model.py`
- [Dataset store](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/store.py): `pyrpoc/data_library/store.py`
- [Data library view](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/data_library/panel.py): `pyrpoc/data_library/panel.py`
- [Dataset frames](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/dataset.py): `pyrpoc/structs/data_library/dataset.py`
- [Recording writers](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/saving.py): `pyrpoc/structs/data_library/saving.py`

### Shared contracts

- [Data kinds](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/data_library/data.py): `pyrpoc/structs/data_library/data.py`
- [Plugin registry](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/registry.py): `pyrpoc/structs/registry.py`
- [Device contract](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/devices.py): `pyrpoc/structs/plugins/devices.py`
- [Program contract](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/programs/program.py): `pyrpoc/structs/plugins/programs/program.py`
- [Parameter model](https://github.com/fishyishyfishy/pyrpoc/blob/main/pyrpoc/structs/plugins/params.py): `pyrpoc/structs/plugins/params.py`

### Other components

- **Workbench user**

## Connections

- Workbench user → Application launch: launches (evidence: `README.md`)
- Application launch → Application state: creates (evidence: `pyrpoc/main.py`)
- Application launch → Workbench window: opens (evidence: `pyrpoc/main.py`)
- Application state → Device inventory: creates (evidence: `pyrpoc/app/application.py`)
- Application state → Library model: creates (evidence: `pyrpoc/app/application.py`)
- Application state → Dataset store: creates (evidence: `pyrpoc/app/application.py`)
- Application state → Acquisition setup: creates (evidence: `pyrpoc/app/application.py`)
- Application state → Plugin registry: loads plugins (evidence: `pyrpoc/app/application.py`)
- Acquisition controls → Acquisition setup: edits (evidence: `pyrpoc/acquisition/panel.py`)
- Acquisition setup → Run executor: starts runs
- Run executor → Program contract: uses program API (evidence: `pyrpoc/acquisition/executor.py`)
- Run executor → Device contract: resolves devices (evidence: `pyrpoc/acquisition/executor.py`)
- Run executor → Dataset frames: creates outputs (evidence: `pyrpoc/acquisition/executor.py`)
- Run executor → Recording writers: configures recording (evidence: `pyrpoc/acquisition/executor.py`)
- Run executor → Dataset store: updates store (evidence: `pyrpoc/acquisition/executor.py`)
- Acquisition programs → Program contract: implements (evidence: `pyrpoc/plugins/programs/confocal/program.py`)
- Acquisition programs → Run-loop helpers: calls helpers (evidence: `pyrpoc/plugins/programs/confocal/program.py`)
- Acquisition programs → Parameter blocks: declares blocks (evidence: `pyrpoc/plugins/programs/confocal/program.py`)
- Acquisition programs → Galvo raster: calls raster (evidence: `pyrpoc/plugins/programs/confocal/program.py`)
- Run-loop helpers → Program contract: uses run context (evidence: `pyrpoc/plugins/programs/building_blocks/functions/run_loops.py`)
- Run-loop helpers → Parameter blocks: reads mosaic settings (evidence: `pyrpoc/plugins/programs/building_blocks/functions/run_loops.py`)
- Instrument drivers → Device contract: implements (evidence: `pyrpoc/plugins/devices/__init__.py`)
- Device inventory → Device contract: manages devices (evidence: `pyrpoc/device_inventory/inventory.py`)
- Library model → Dataset store: uses store (evidence: `pyrpoc/app/application.py`)
- Data library view → Library model: reads library (evidence: `pyrpoc/data_library/panel.py`)
- Data library view → Data display plugins: selects renderers (evidence: `pyrpoc/data_library/panel.py`)
- Dataset frames → Data kinds: validates frames (evidence: `pyrpoc/structs/data_library/dataset.py`)
- Dataset frames → Recording writers: writes frames (evidence: `pyrpoc/structs/data_library/dataset.py`)
- Program contract → Dataset frames: publishes outputs (evidence: `pyrpoc/structs/plugins/programs/program.py`)
- Program contract → Device contract: declares requirements (evidence: `pyrpoc/structs/plugins/programs/program.py`)
- Parameter model → Plugin registry: registers blocks (evidence: `pyrpoc/structs/plugins/params.py`)
- Data display plugins → Data kinds: renders data kinds
