# geoscienceaustralia/ginan architecture

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

- Interactive diagram: https://gitdiagram.com/geoscienceaustralia/ginan
- Repository: https://github.com/geoscienceaustralia/ginan

## Overview

Ginan is a GNSS analysis toolkit whose central workflow is to configure PEA, process GNSS observations for positioning and orbit determination, and produce analysis products. The README also identifies atmospheric modeling, real-time corrections, SLR, and offline/real-time operation as capabilities. The graph includes the documented Python UI and analysis tools alongside PEA’s processing and shared foundations. Source excerpts show only parts of the runtime; edges without direct excerpt evidence are limited to README claims or indexed references.

Main entry points: [`src/cpp/pea/main.cpp`](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/main.cpp) (PEA entry point), [`scripts/GinanUI/app/controllers/input_controller.py`](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/input_controller.py) (Input workflow), [`scripts/GinanUI/app/models/dl_products.py`](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/dl_products.py) (Product downloads), [`src/cpp/common/algebra.hpp`](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/algebra.hpp) (Estimation algebra)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_pea["PEA Processing"]
  node_pea_main["PEA entry point<br/>[main.cpp]"]
  node_config["Processing config<br/>[acsConfig.hpp]"]
  node_observations["Observation streams<br/>[observations.hpp]"]
  node_receiver["Receiver metadata<br/>[receiver.hpp]"]
  node_ppp["PPP estimation<br/>[ppp.cpp]"]
  node_preprocessor["Observation preparation<br/>[preprocessor.cpp]"]
  node_outputs["Solution outputs<br/>[outputs.cpp]"]
end

subgraph group_foundation["GNSS Foundations"]
  node_common["Shared GNSS types<br/>[enums.h]"]
  node_time["GNSS time<br/>[gTime.hpp]"]
  node_algebra["Estimation algebra<br/>[algebra.hpp]"]
  node_attitude["Satellite attitude<br/>[attitude.hpp]"]
  node_eigen["Linear algebra types<br/>[eigenIncluder.hpp]"]
  node_sinex["SINEX exchange<br/>[sinex.hpp]"]
  node_trace["Trace logging<br/>[trace.hpp]"]
end

subgraph group_models["Analysis Models"]
  node_orbit["Orbit propagation<br/>[orbitProp.cpp]"]
  node_iono["Ionosphere models<br/>[ionoModel.cpp]"]
  node_trop["Troposphere models<br/>[tropModels.cpp]"]
  node_slr["Laser ranging<br/>[slrObs.cpp]"]
  node_realtime["Real-time corrections<br/>[ntripBroadcast.cpp]"]
end

subgraph group_ui["Ginan UI"]
  node_ui_input["Input workflow"]
  node_ui_config["Configuration controls"]
  node_ui_execution["Execution bridge<br/>[execution.py]"]
  node_ui_products["Product downloads<br/>[dl_products.py]"]
  node_ui_archive["Product archives<br/>[archive_manager.py]"]
  node_ui_workers["Background workers<br/>[workers.py]"]
  node_ui_logger["UI logging<br/>[logger.py]"]
  node_ui_dirs["UI directories<br/>[common_dirs.py]"]
  node_visualisation["Visualisation controls"]
end

subgraph group_tools["Analysis Tools"]
  node_plot_trace["Trace analysis plots<br/>[plot_trace_res.py]"]
  node_gn_tools["RINEX utilities<br/>[main.py]"]
  node_eda["GNSS data browser"]
end

node_user(("GNSS analyst"))

node_user -->|"sets up run"| node_ui_input
node_user -->|"runs analysis"| node_pea_main
node_ui_input -->|"coordinates"| node_ui_config
node_ui_input -->|"uses execution"| node_ui_execution
node_ui_input -.->|"starts processing"| node_pea_main
node_ui_input -->|"requests products"| node_ui_products
node_ui_input -->|"archives products"| node_ui_archive
node_ui_products -->|"uses archive"| node_ui_archive
node_ui_products -->|"uses paths"| node_ui_dirs
node_ui_products -->|"runs in workers"| node_ui_workers
node_ui_input -->|"logs workflow"| node_ui_logger
node_visualisation -.->|"views plots"| node_plot_trace
node_pea_main -->|"reads config"| node_config
node_pea_main -->|"processes streams"| node_observations
node_pea_main -->|"uses receiver state"| node_receiver
node_pea_main -.->|"prepares observations"| node_preprocessor
node_pea_main -.->|"runs estimation"| node_ppp
node_pea_main -.->|"writes results"| node_outputs
node_pea_main -->|"supports orbit determination"| node_orbit
node_pea_main -->|"supports atmospheric models"| node_iono
node_pea_main -->|"supports atmospheric models"| node_trop
node_pea_main -->|"processes SLR"| node_slr
node_pea_main -->|"generates corrections"| node_realtime
node_algebra -->|"uses types"| node_eigen
node_algebra -->|"uses enums"| node_common
node_algebra -->|"uses time types"| node_time
node_receiver -->|"uses attitude"| node_attitude
node_sinex -->|"uses time types"| node_time
node_trace -->|"uses types"| node_eigen
node_user -->|"prepares data"| node_gn_tools
node_user -->|"analyzes results"| node_plot_trace
node_user -.->|"browses results"| node_eda

click node_pea_main "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/main.cpp"
click node_config "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/acsConfig.hpp"
click node_observations "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/observations.hpp"
click node_receiver "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/receiver.hpp"
click node_ppp "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/ppp.cpp"
click node_preprocessor "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/preprocessor.cpp"
click node_outputs "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/outputs.cpp"
click node_orbit "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/orbprop/orbitProp.cpp"
click node_iono "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/iono/ionoModel.cpp"
click node_trop "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/trop/tropModels.cpp"
click node_slr "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/slr/slrObs.cpp"
click node_realtime "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/ntripBroadcast.cpp"
click node_common "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/enums.h"
click node_time "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/gTime.hpp"
click node_algebra "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/algebra.hpp"
click node_attitude "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/attitude.hpp"
click node_eigen "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/eigenIncluder.hpp"
click node_sinex "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/sinex.hpp"
click node_trace "https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/trace.hpp"
click node_ui_input "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/input_controller.py"
click node_ui_config "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/general_config_controller.py"
click node_ui_execution "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/execution.py"
click node_ui_products "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/dl_products.py"
click node_ui_archive "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/archive_manager.py"
click node_ui_workers "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/workers.py"
click node_ui_logger "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/logger.py"
click node_ui_dirs "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/common_dirs.py"
click node_visualisation "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/visualisation_controller.py"
click node_plot_trace "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/plot_trace_res.py"
click node_gn_tools "https://github.com/geoscienceaustralia/ginan/blob/main/scripts/gn/main.py"
click node_eda "https://github.com/geoscienceaustralia/ginan/tree/main/scripts/GinanEDA/eda/routes"

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_pea_main,node_config,node_observations,node_receiver,node_ppp,node_preprocessor,node_outputs toneBlue
class node_common,node_time,node_algebra,node_attitude,node_eigen,node_sinex,node_trace toneAmber
class node_orbit,node_iono,node_trop,node_slr,node_realtime toneMint
class node_ui_input,node_ui_config,node_ui_execution,node_ui_products,node_ui_archive,node_ui_workers,node_ui_logger,node_ui_dirs,node_visualisation toneRose
class node_plot_trace,node_gn_tools,node_eda,node_user toneIndigo
```

## Components

### PEA Processing

- [PEA entry point](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/main.cpp): `src/cpp/pea/main.cpp`
- [Processing config](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/acsConfig.hpp): `src/cpp/common/acsConfig.hpp`
- [Observation streams](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/observations.hpp): `src/cpp/common/observations.hpp`
- [Receiver metadata](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/receiver.hpp): `src/cpp/common/receiver.hpp`
- [PPP estimation](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/ppp.cpp): `src/cpp/pea/ppp.cpp`
- [Observation preparation](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/preprocessor.cpp): `src/cpp/pea/preprocessor.cpp`
- [Solution outputs](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/pea/outputs.cpp): `src/cpp/pea/outputs.cpp`

### GNSS Foundations

- [Shared GNSS types](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/enums.h): `src/cpp/common/enums.h`
- [GNSS time](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/gTime.hpp): `src/cpp/common/gTime.hpp`
- [Estimation algebra](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/algebra.hpp): `src/cpp/common/algebra.hpp`
- [Satellite attitude](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/attitude.hpp): `src/cpp/common/attitude.hpp`
- [Linear algebra types](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/eigenIncluder.hpp): `src/cpp/common/eigenIncluder.hpp`
- [SINEX exchange](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/sinex.hpp): `src/cpp/common/sinex.hpp`
- [Trace logging](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/trace.hpp): `src/cpp/common/trace.hpp`

### Analysis Models

- [Orbit propagation](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/orbprop/orbitProp.cpp): `src/cpp/orbprop/orbitProp.cpp`
- [Ionosphere models](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/iono/ionoModel.cpp): `src/cpp/iono/ionoModel.cpp`
- [Troposphere models](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/trop/tropModels.cpp): `src/cpp/trop/tropModels.cpp`
- [Laser ranging](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/slr/slrObs.cpp): `src/cpp/slr/slrObs.cpp`
- [Real-time corrections](https://github.com/geoscienceaustralia/ginan/blob/main/src/cpp/common/ntripBroadcast.cpp): `src/cpp/common/ntripBroadcast.cpp`

### Ginan UI

- [Input workflow](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/input_controller.py): `scripts/GinanUI/app/controllers/input_controller.py`
- [Configuration controls](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/general_config_controller.py): `scripts/GinanUI/app/controllers/general_config_controller.py`
- [Execution bridge](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/execution.py): `scripts/GinanUI/app/models/execution.py`
- [Product downloads](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/dl_products.py): `scripts/GinanUI/app/models/dl_products.py`
- [Product archives](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/models/archive_manager.py): `scripts/GinanUI/app/models/archive_manager.py`
- [Background workers](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/workers.py): `scripts/GinanUI/app/utils/workers.py`
- [UI logging](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/logger.py): `scripts/GinanUI/app/utils/logger.py`
- [UI directories](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/utils/common_dirs.py): `scripts/GinanUI/app/utils/common_dirs.py`
- [Visualisation controls](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/GinanUI/app/controllers/visualisation_controller.py): `scripts/GinanUI/app/controllers/visualisation_controller.py`

### Analysis Tools

- [Trace analysis plots](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/plot_trace_res.py): `scripts/plot_trace_res.py`
- [RINEX utilities](https://github.com/geoscienceaustralia/ginan/blob/main/scripts/gn/main.py): `scripts/gn/main.py`
- [GNSS data browser](https://github.com/geoscienceaustralia/ginan/tree/main/scripts/GinanEDA/eda/routes): `scripts/GinanEDA/eda/routes`

### Other components

- **GNSS analyst**

## Connections

- GNSS analyst → Input workflow: sets up run (evidence: `README.md`)
- GNSS analyst → PEA entry point: runs analysis (evidence: `README.md`)
- Input workflow → Configuration controls: coordinates (evidence: `scripts/GinanUI/app/controllers/input_controller.py`)
- Input workflow → Execution bridge: uses execution (evidence: `scripts/GinanUI/app/controllers/input_controller.py`)
- Input workflow → PEA entry point: starts processing
- Input workflow → Product downloads: requests products (evidence: `scripts/GinanUI/app/controllers/input_controller.py`)
- Input workflow → Product archives: archives products (evidence: `scripts/GinanUI/app/controllers/input_controller.py`)
- Product downloads → Product archives: uses archive (evidence: `scripts/GinanUI/app/models/dl_products.py`)
- Product downloads → UI directories: uses paths (evidence: `scripts/GinanUI/app/models/dl_products.py`)
- Product downloads → Background workers: runs in workers (evidence: `scripts/GinanUI/app/utils/workers.py`)
- Input workflow → UI logging: logs workflow (evidence: `scripts/GinanUI/app/controllers/input_controller.py`)
- Visualisation controls → Trace analysis plots: views plots
- PEA entry point → Processing config: reads config (evidence: `src/cpp/pea/main.cpp`)
- PEA entry point → Observation streams: processes streams (evidence: `src/cpp/pea/main.cpp`)
- PEA entry point → Receiver metadata: uses receiver state (evidence: `src/cpp/pea/main.cpp`)
- PEA entry point → Observation preparation: prepares observations
- PEA entry point → PPP estimation: runs estimation
- PEA entry point → Solution outputs: writes results
- PEA entry point → Orbit propagation: supports orbit determination (evidence: `README.md`)
- PEA entry point → Ionosphere models: supports atmospheric models (evidence: `README.md`)
- PEA entry point → Troposphere models: supports atmospheric models (evidence: `README.md`)
- PEA entry point → Laser ranging: processes SLR (evidence: `README.md`)
- PEA entry point → Real-time corrections: generates corrections (evidence: `README.md`)
- Estimation algebra → Linear algebra types: uses types (evidence: `src/cpp/common/algebra.hpp`)
- Estimation algebra → Shared GNSS types: uses enums (evidence: `src/cpp/common/algebra.hpp`)
- Estimation algebra → GNSS time: uses time types (evidence: `src/cpp/common/algebra.hpp`)
- Receiver metadata → Satellite attitude: uses attitude (evidence: `src/cpp/common/receiver.hpp`)
- SINEX exchange → GNSS time: uses time types (evidence: `src/cpp/common/sinex.hpp`)
- Trace logging → Linear algebra types: uses types (evidence: `src/cpp/common/trace.hpp`)
- GNSS analyst → RINEX utilities: prepares data (evidence: `README.md`)
- GNSS analyst → Trace analysis plots: analyzes results (evidence: `README.md`)
- GNSS analyst → GNSS data browser: browses results
