# dhi/mikeio architecture

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

- Interactive diagram: https://gitdiagram.com/dhi/mikeio
- Repository: https://github.com/dhi/mikeio

## Overview

MIKE IO is a Python library for reading, writing, and processing MIKE dfs and mesh files. The main workflow is a user calling the public read API, which dispatches to a format-specific reader and returns a Dataset of DataArrays; users select, sample, or transform that data and may write it back. The graph also preserves documented plotting, spatial, spectral, generic-file, and PFS capabilities. Edges are limited to README statements or relationships visible in excerpts and the source index; unsampled implementation links are omitted.

Main entry points: [`src/mikeio/dataset/_dataarray.py`](https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataarray.py) (DataArray), [`src/mikeio/dataset/_dataset.py`](https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataset.py) (Dataset), [`src/mikeio/__init__.py`](https://github.com/dhi/mikeio/blob/main/src/mikeio/__init__.py) (Read and open API), [`src/mikeio/dfs/_dfs.py`](https://github.com/dhi/mikeio/blob/main/src/mikeio/dfs/_dfs.py) (DFS file handling)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_public["Read and open API<br/>[__init__.py]"]
end

subgraph group_formats["File I/O"]
  node_dfs_readers["DFS readers"]
  node_dfs_base["DFS file handling<br/>[_dfs.py]"]
  node_dfsu["DFSU files<br/>[_dfsu.py]"]
  node_generic["Generic files<br/>[generic.py]"]
  node_pfs["PFS documents<br/>[_pfsdocument.py]"]
  node_custom_blocks["Custom DFS blocks<br/>[_custom_blocks.py]"]
end

subgraph group_data["Data processing"]
  node_dataset["Dataset<br/>[_dataset.py]"]
  node_dataarray["DataArray<br/>[_dataarray.py]"]
  node_interpolation["Interpolation<br/>[_interpolation.py]"]
  node_track["Track extraction<br/>[_track.py]"]
  node_spectral["Spectral data<br/>[_spectral.py]"]
end

subgraph group_spatial["Spatial and plotting"]
  node_geometry["Mesh geometry<br/>[_FM_geometry.py]"]
  node_layered_geometry["Layered geometry"]
  node_grid_geometry["Grid geometry<br/>[_grid_geometry.py]"]
  node_spatial_helpers["Geometry utilities<br/>[_distance.py]"]
  node_plotting["Data and mesh plots<br/>[_data_plot.py]"]
end

subgraph group_metadata["Metadata and configuration"]
  node_eum["EUM metadata<br/>[_eum.py]"]
  node_options["Runtime options<br/>[_options.py]"]
  node_paths["Path handling<br/>[_path.py]"]
  node_exceptions["Domain exceptions<br/>[exceptions.py]"]
  node_deprecation["Deprecation helpers<br/>[_deprecation.py]"]
end

node_user(("Python user"))

node_user -->|"calls"| node_public
node_public -->|"dispatches reads"| node_dfs_readers
node_dfs_readers -->|"uses base"| node_dfs_base
node_public -->|"opens DFSU"| node_dfsu
node_public -->|"returns data"| node_dataset
node_dataset -->|"holds arrays"| node_dataarray
node_dataset -->|"writes DFS"| node_dfs_readers
node_dataarray -->|"uses interpolation"| node_interpolation
node_dfsu -->|"returns data"| node_dataset
node_dfsu -->|"uses geometry"| node_geometry
node_dataset -->|"writes DFSU"| node_dfsu
node_dataarray -->|"uses geometry"| node_geometry
node_dataarray -->|"dispatches by geometry"| node_layered_geometry
node_dataarray -->|"uses geometry"| node_grid_geometry
node_geometry -->|"uses distance"| node_spatial_helpers
node_layered_geometry -->|"extends geometry"| node_geometry
node_dataarray -->|"selects plotter"| node_plotting
node_dataset -->|"uses plotter"| node_plotting
node_layered_geometry -->|"uses plotter"| node_plotting
node_public -->|"exposes file access"| node_generic
node_public -->|"exposes PFS access"| node_pfs
node_dataset -->|"uses track tools"| node_track
node_dataarray -->|"uses item metadata"| node_eum
node_dfs_base -->|"handles blocks"| node_custom_blocks
node_dfs_base -->|"reads options"| node_options
node_dfs_base -->|"normalizes paths"| node_paths
node_generic -->|"uses DFS handling"| node_dfs_base
node_eum -->|"raises errors"| node_exceptions
node_plotting -->|"warns callers"| node_deprecation
node_dfsu -->|"supports spectra"| node_spectral

click node_public "https://github.com/dhi/mikeio/blob/main/src/mikeio/__init__.py"
click node_dfs_readers "https://github.com/dhi/mikeio/tree/main/src/mikeio/dfs"
click node_dfs_base "https://github.com/dhi/mikeio/blob/main/src/mikeio/dfs/_dfs.py"
click node_dfsu "https://github.com/dhi/mikeio/blob/main/src/mikeio/dfsu/_dfsu.py"
click node_generic "https://github.com/dhi/mikeio/blob/main/src/mikeio/generic.py"
click node_pfs "https://github.com/dhi/mikeio/blob/main/src/mikeio/pfs/_pfsdocument.py"
click node_dataset "https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataset.py"
click node_dataarray "https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataarray.py"
click node_interpolation "https://github.com/dhi/mikeio/blob/main/src/mikeio/_interpolation.py"
click node_track "https://github.com/dhi/mikeio/blob/main/src/mikeio/_track.py"
click node_geometry "https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_FM_geometry.py"
click node_layered_geometry "https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_FM_geometry_layered.py"
click node_grid_geometry "https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_grid_geometry.py"
click node_spatial_helpers "https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_distance.py"
click node_plotting "https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_data_plot.py"
click node_spectral "https://github.com/dhi/mikeio/blob/main/src/mikeio/_spectral.py"
click node_eum "https://github.com/dhi/mikeio/blob/main/src/mikeio/eum/_eum.py"
click node_options "https://github.com/dhi/mikeio/blob/main/src/mikeio/_options.py"
click node_paths "https://github.com/dhi/mikeio/blob/main/src/mikeio/_path.py"
click node_custom_blocks "https://github.com/dhi/mikeio/blob/main/src/mikeio/dfs/_custom_blocks.py"
click node_exceptions "https://github.com/dhi/mikeio/blob/main/src/mikeio/exceptions.py"
click node_deprecation "https://github.com/dhi/mikeio/blob/main/src/mikeio/_deprecation.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_public,node_user toneBlue
class node_dfs_readers,node_dfs_base,node_dfsu,node_generic,node_pfs,node_custom_blocks toneAmber
class node_dataset,node_dataarray,node_interpolation,node_track,node_spectral toneMint
class node_geometry,node_layered_geometry,node_grid_geometry,node_spatial_helpers,node_plotting toneRose
class node_eum,node_options,node_paths,node_exceptions,node_deprecation toneIndigo
```

## Components

### Public API

- [Read and open API](https://github.com/dhi/mikeio/blob/main/src/mikeio/__init__.py): `src/mikeio/__init__.py`

### File I/O

- [DFS readers](https://github.com/dhi/mikeio/tree/main/src/mikeio/dfs): `src/mikeio/dfs`
- [DFS file handling](https://github.com/dhi/mikeio/blob/main/src/mikeio/dfs/_dfs.py): `src/mikeio/dfs/_dfs.py`
- [DFSU files](https://github.com/dhi/mikeio/blob/main/src/mikeio/dfsu/_dfsu.py): `src/mikeio/dfsu/_dfsu.py`
- [Generic files](https://github.com/dhi/mikeio/blob/main/src/mikeio/generic.py): `src/mikeio/generic.py`
- [PFS documents](https://github.com/dhi/mikeio/blob/main/src/mikeio/pfs/_pfsdocument.py): `src/mikeio/pfs/_pfsdocument.py`
- [Custom DFS blocks](https://github.com/dhi/mikeio/blob/main/src/mikeio/dfs/_custom_blocks.py): `src/mikeio/dfs/_custom_blocks.py`

### Data processing

- [Dataset](https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataset.py): `src/mikeio/dataset/_dataset.py`
- [DataArray](https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_dataarray.py): `src/mikeio/dataset/_dataarray.py`
- [Interpolation](https://github.com/dhi/mikeio/blob/main/src/mikeio/_interpolation.py): `src/mikeio/_interpolation.py`
- [Track extraction](https://github.com/dhi/mikeio/blob/main/src/mikeio/_track.py): `src/mikeio/_track.py`
- [Spectral data](https://github.com/dhi/mikeio/blob/main/src/mikeio/_spectral.py): `src/mikeio/_spectral.py`

### Spatial and plotting

- [Mesh geometry](https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_FM_geometry.py): `src/mikeio/spatial/_FM_geometry.py`
- [Layered geometry](https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_FM_geometry_layered.py): `src/mikeio/spatial/_FM_geometry_layered.py`
- [Grid geometry](https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_grid_geometry.py): `src/mikeio/spatial/_grid_geometry.py`
- [Geometry utilities](https://github.com/dhi/mikeio/blob/main/src/mikeio/spatial/_distance.py): `src/mikeio/spatial/_distance.py`
- [Data and mesh plots](https://github.com/dhi/mikeio/blob/main/src/mikeio/dataset/_data_plot.py): `src/mikeio/dataset/_data_plot.py`

### Metadata and configuration

- [EUM metadata](https://github.com/dhi/mikeio/blob/main/src/mikeio/eum/_eum.py): `src/mikeio/eum/_eum.py`
- [Runtime options](https://github.com/dhi/mikeio/blob/main/src/mikeio/_options.py): `src/mikeio/_options.py`
- [Path handling](https://github.com/dhi/mikeio/blob/main/src/mikeio/_path.py): `src/mikeio/_path.py`
- [Domain exceptions](https://github.com/dhi/mikeio/blob/main/src/mikeio/exceptions.py): `src/mikeio/exceptions.py`
- [Deprecation helpers](https://github.com/dhi/mikeio/blob/main/src/mikeio/_deprecation.py): `src/mikeio/_deprecation.py`

### Other components

- **Python user**

## Connections

- Python user → Read and open API: calls (evidence: `src/mikeio/__init__.py`)
- Read and open API → DFS readers: dispatches reads (evidence: `src/mikeio/__init__.py`)
- DFS readers → DFS file handling: uses base (evidence: `src/mikeio/dfs/_dfs0.py`)
- Read and open API → DFSU files: opens DFSU (evidence: `src/mikeio/__init__.py`)
- Read and open API → Dataset: returns data (evidence: `README.md`)
- Dataset → DataArray: holds arrays (evidence: `src/mikeio/dataset/_dataset.py`)
- Dataset → DFS readers: writes DFS (evidence: `src/mikeio/dataset/_dataset.py`)
- DataArray → Interpolation: uses interpolation (evidence: `src/mikeio/dataset/_dataarray.py`)
- DFSU files → Dataset: returns data (evidence: `src/mikeio/dfsu/_dfsu.py`)
- DFSU files → Mesh geometry: uses geometry (evidence: `src/mikeio/dfsu/_dfsu.py`)
- Dataset → DFSU files: writes DFSU (evidence: `src/mikeio/dataset/_dataset.py`)
- DataArray → Mesh geometry: uses geometry (evidence: `src/mikeio/dataset/_dataarray.py`)
- DataArray → Layered geometry: dispatches by geometry (evidence: `src/mikeio/dataset/_dataarray.py`)
- DataArray → Grid geometry: uses geometry (evidence: `src/mikeio/dataset/_dataarray.py`)
- Mesh geometry → Geometry utilities: uses distance (evidence: `src/mikeio/spatial/_FM_geometry.py`)
- Layered geometry → Mesh geometry: extends geometry (evidence: `src/mikeio/spatial/_FM_geometry_layered.py`)
- DataArray → Data and mesh plots: selects plotter (evidence: `src/mikeio/dataset/_dataarray.py`)
- Dataset → Data and mesh plots: uses plotter (evidence: `src/mikeio/dataset/_dataset.py`)
- Layered geometry → Data and mesh plots: uses plotter
- Read and open API → Generic files: exposes file access (evidence: `src/mikeio/__init__.py`)
- Read and open API → PFS documents: exposes PFS access (evidence: `src/mikeio/__init__.py`)
- Dataset → Track extraction: uses track tools (evidence: `src/mikeio/dataset/_dataset.py`)
- DataArray → EUM metadata: uses item metadata (evidence: `src/mikeio/dataset/_dataarray.py`)
- DFS file handling → Custom DFS blocks: handles blocks (evidence: `src/mikeio/dfs/_dfs.py`)
- DFS file handling → Runtime options: reads options (evidence: `src/mikeio/dfs/_dfs.py`)
- DFS file handling → Path handling: normalizes paths (evidence: `src/mikeio/dfs/_dfs.py`)
- Generic files → DFS file handling: uses DFS handling (evidence: `src/mikeio/generic.py`)
- EUM metadata → Domain exceptions: raises errors (evidence: `src/mikeio/eum/_eum.py`)
- Data and mesh plots → Deprecation helpers: warns callers (evidence: `src/mikeio/dataset/_data_plot.py`)
- DFSU files → Spectral data: supports spectra (evidence: `src/mikeio/dfsu/_spectral.py`)
