# kritt29/nirnay architecture

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

## Overview

NIRNAY is a synthetic Antarctic-voyage planning demo. Its main workflow accepts vessel and voyage inputs, forecasts sea ice and iceberg risk, fuses those fields into navigation hazards, plans routes to a station approach, and supports clock advancement and replanning. The API also exposes hazard imagery and bounds; the repository includes synthetic data generation and forecast scoring. Source excerpts and the index establish the main module dependencies, but some API helper implementations and subsystem details were not shown, so edges are limited to documented or indexed relationships.

Main entry points: [`api/main.py`](https://github.com/kritt29/nirnay/blob/main/api/main.py) (Demo API), [`data/cube.py`](https://github.com/kritt29/nirnay/blob/main/data/cube.py) (Cube access), [`routing/plan.py`](https://github.com/kritt29/nirnay/blob/main/routing/plan.py) (Time-dependent routing), [`hazard/fuse.py`](https://github.com/kritt29/nirnay/blob/main/hazard/fuse.py) (Hazard fusion)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["Voyage API"]
  node_api["Demo API<br/>[main.py]"]
  node_voyage["Voyage initialization<br/>[main.py]"]
  node_hazard_view["Hazard imagery<br/>[main.py]"]
  node_route_api["Route requests<br/>[main.py]"]
  node_replay["Clock and replan<br/>[main.py]"]
end

subgraph group_environment["Environmental Data"]
  node_cube[("Cube access<br/>[cube.py]")]
  node_synthetic["Synthetic cube generation<br/>[synthetic.py]"]
end

subgraph group_models["Forecast And Hazard"]
  node_sic["Sea-ice forecast<br/>[baseline.py]"]
  node_berg["Berg ensemble<br/>[berg.py]"]
  node_fusion["Hazard fusion<br/>[fuse.py]"]
end

subgraph group_navigation["Navigation And Evaluation"]
  node_planner["Time-dependent routing<br/>[plan.py]"]
  node_route_metrics["Route summaries<br/>[plan.py]"]
  node_scoring["Forecast scoring<br/>[score.py]"]
end

node_operator(("Voyage client"))

node_operator -->|"requests"| node_api
node_api -->|"serves"| node_voyage
node_api -->|"serves"| node_hazard_view
node_api -->|"serves"| node_route_api
node_api -->|"serves"| node_replay
node_api -->|"reads"| node_cube
node_api -->|"uses"| node_sic
node_api -->|"uses"| node_berg
node_api -->|"uses"| node_fusion
node_api -->|"calls"| node_planner
node_sic -->|"reads"| node_cube
node_berg -->|"reads"| node_cube
node_fusion -->|"calls"| node_sic
node_fusion -->|"calls"| node_berg
node_planner -->|"reads"| node_cube
node_planner -->|"uses"| node_fusion
node_planner -->|"summarizes"| node_route_metrics
node_scoring -->|"reads"| node_cube
node_scoring -->|"scores"| node_sic

click node_api "https://github.com/kritt29/nirnay/blob/main/api/main.py"
click node_voyage "https://github.com/kritt29/nirnay/blob/main/api/main.py"
click node_hazard_view "https://github.com/kritt29/nirnay/blob/main/api/main.py"
click node_route_api "https://github.com/kritt29/nirnay/blob/main/api/main.py"
click node_replay "https://github.com/kritt29/nirnay/blob/main/api/main.py"
click node_cube "https://github.com/kritt29/nirnay/blob/main/data/cube.py"
click node_synthetic "https://github.com/kritt29/nirnay/blob/main/data/synthetic.py"
click node_sic "https://github.com/kritt29/nirnay/blob/main/forecast/baseline.py"
click node_berg "https://github.com/kritt29/nirnay/blob/main/forecast/berg.py"
click node_fusion "https://github.com/kritt29/nirnay/blob/main/hazard/fuse.py"
click node_planner "https://github.com/kritt29/nirnay/blob/main/routing/plan.py"
click node_route_metrics "https://github.com/kritt29/nirnay/blob/main/routing/plan.py"
click node_scoring "https://github.com/kritt29/nirnay/blob/main/eval/score.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_api,node_voyage,node_hazard_view,node_route_api,node_replay,node_operator toneBlue
class node_cube,node_synthetic toneAmber
class node_sic,node_berg,node_fusion toneMint
class node_planner,node_route_metrics,node_scoring toneRose
```

## Components

### Voyage API

- [Demo API](https://github.com/kritt29/nirnay/blob/main/api/main.py): `api/main.py`
- [Voyage initialization](https://github.com/kritt29/nirnay/blob/main/api/main.py): `api/main.py`
- [Hazard imagery](https://github.com/kritt29/nirnay/blob/main/api/main.py): `api/main.py`
- [Route requests](https://github.com/kritt29/nirnay/blob/main/api/main.py): `api/main.py`
- [Clock and replan](https://github.com/kritt29/nirnay/blob/main/api/main.py): `api/main.py`

### Environmental Data

- [Cube access](https://github.com/kritt29/nirnay/blob/main/data/cube.py): `data/cube.py`
- [Synthetic cube generation](https://github.com/kritt29/nirnay/blob/main/data/synthetic.py): `data/synthetic.py`

### Forecast And Hazard

- [Sea-ice forecast](https://github.com/kritt29/nirnay/blob/main/forecast/baseline.py): `forecast/baseline.py`
- [Berg ensemble](https://github.com/kritt29/nirnay/blob/main/forecast/berg.py): `forecast/berg.py`
- [Hazard fusion](https://github.com/kritt29/nirnay/blob/main/hazard/fuse.py): `hazard/fuse.py`

### Navigation And Evaluation

- [Time-dependent routing](https://github.com/kritt29/nirnay/blob/main/routing/plan.py): `routing/plan.py`
- [Route summaries](https://github.com/kritt29/nirnay/blob/main/routing/plan.py): `routing/plan.py`
- [Forecast scoring](https://github.com/kritt29/nirnay/blob/main/eval/score.py): `eval/score.py`

### Other components

- **Voyage client**

## Connections

- Voyage client → Demo API: requests (evidence: `api/main.py`)
- Demo API → Voyage initialization: serves (evidence: `api/main.py`)
- Demo API → Hazard imagery: serves (evidence: `api/main.py`)
- Demo API → Route requests: serves (evidence: `api/main.py`)
- Demo API → Clock and replan: serves (evidence: `api/main.py`)
- Demo API → Cube access: reads (evidence: `api/main.py`)
- Demo API → Sea-ice forecast: uses (evidence: `api/main.py`)
- Demo API → Berg ensemble: uses (evidence: `api/main.py`)
- Demo API → Hazard fusion: uses (evidence: `api/main.py`)
- Demo API → Time-dependent routing: calls (evidence: `api/main.py`)
- Sea-ice forecast → Cube access: reads (evidence: `forecast/baseline.py`)
- Berg ensemble → Cube access: reads (evidence: `forecast/berg.py`)
- Hazard fusion → Sea-ice forecast: calls (evidence: `hazard/fuse.py`)
- Hazard fusion → Berg ensemble: calls (evidence: `hazard/fuse.py`)
- Time-dependent routing → Cube access: reads (evidence: `routing/plan.py`)
- Time-dependent routing → Hazard fusion: uses (evidence: `routing/plan.py`)
- Time-dependent routing → Route summaries: summarizes (evidence: `routing/plan.py`)
- Forecast scoring → Cube access: reads (evidence: `eval/score.py`)
- Forecast scoring → Sea-ice forecast: scores (evidence: `eval/score.py`)
