How dhi/mikeio works
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: _dataarray.py DataArray · _dataset.py Dataset · __init__.py Read and open API · _dfs.py DFS file handling
Components 23
Public API
- Read and open API
src/mikeio/__init__.py
File I/O
- DFS readers
src/mikeio/dfs - DFS file handling
src/mikeio/dfs/_dfs.py - DFSU files
src/mikeio/dfsu/_dfsu.py - Generic files
src/mikeio/generic.py - PFS documents
src/mikeio/pfs/_pfsdocument.py - Custom DFS blocks
src/mikeio/dfs/_custom_blocks.py
Data processing
- Dataset
src/mikeio/dataset/_dataset.py - DataArray
src/mikeio/dataset/_dataarray.py - Interpolation
src/mikeio/_interpolation.py - Track extraction
src/mikeio/_track.py - Spectral data
src/mikeio/_spectral.py
Spatial and plotting
- Mesh geometry
src/mikeio/spatial/_FM_geometry.py - Layered geometry
src/mikeio/spatial/_FM_geometry_layered.py - Grid geometry
src/mikeio/spatial/_grid_geometry.py - Geometry utilities
src/mikeio/spatial/_distance.py - Data and mesh plots
src/mikeio/dataset/_data_plot.py
Metadata and configuration
- EUM metadata
src/mikeio/eum/_eum.py - Runtime options
src/mikeio/_options.py - Path handling
src/mikeio/_path.py - Domain exceptions
src/mikeio/exceptions.py - Deprecation helpers
src/mikeio/_deprecation.py
Other components
- Python user
Connections 30
- Python user → Read and open API: calls
src/mikeio/__init__.py - Read and open API → DFS readers: dispatches reads
src/mikeio/__init__.py - DFS readers → DFS file handling: uses base
src/mikeio/dfs/_dfs0.py - Read and open API → DFSU files: opens DFSU
src/mikeio/__init__.py - Read and open API → Dataset: returns data
README.md - Dataset → DataArray: holds arrays
src/mikeio/dataset/_dataset.py - Dataset → DFS readers: writes DFS
src/mikeio/dataset/_dataset.py - DataArray → Interpolation: uses interpolation
src/mikeio/dataset/_dataarray.py - DFSU files → Dataset: returns data
src/mikeio/dfsu/_dfsu.py - DFSU files → Mesh geometry: uses geometry
src/mikeio/dfsu/_dfsu.py - Dataset → DFSU files: writes DFSU
src/mikeio/dataset/_dataset.py - DataArray → Mesh geometry: uses geometry
src/mikeio/dataset/_dataarray.py - DataArray → Layered geometry: dispatches by geometry
src/mikeio/dataset/_dataarray.py - DataArray → Grid geometry: uses geometry
src/mikeio/dataset/_dataarray.py - Mesh geometry → Geometry utilities: uses distance
src/mikeio/spatial/_FM_geometry.py - Layered geometry → Mesh geometry: extends geometry
src/mikeio/spatial/_FM_geometry_layered.py - DataArray → Data and mesh plots: selects plotter
src/mikeio/dataset/_dataarray.py - Dataset → Data and mesh plots: uses plotter
src/mikeio/dataset/_dataset.py - Layered geometry → Data and mesh plots: uses plotter
- Read and open API → Generic files: exposes file access
src/mikeio/__init__.py - Read and open API → PFS documents: exposes PFS access
src/mikeio/__init__.py - Dataset → Track extraction: uses track tools
src/mikeio/dataset/_dataset.py - DataArray → EUM metadata: uses item metadata
src/mikeio/dataset/_dataarray.py - DFS file handling → Custom DFS blocks: handles blocks
src/mikeio/dfs/_dfs.py - DFS file handling → Runtime options: reads options
src/mikeio/dfs/_dfs.py - DFS file handling → Path handling: normalizes paths
src/mikeio/dfs/_dfs.py - Generic files → DFS file handling: uses DFS handling
src/mikeio/generic.py - EUM metadata → Domain exceptions: raises errors
src/mikeio/eum/_eum.py - Data and mesh plots → Deprecation helpers: warns callers
src/mikeio/dataset/_data_plot.py - DFSU files → Spectral data: supports spectra
src/mikeio/dfsu/_spectral.py