List of D-HYDRO functionalities and support in HYDROLIB-core¶
Below is a list of D-HYDRO functionalities, grouped by kernel, and the current status of support inside hydrolib-core.
Symbology¶
: All toplevel file contents can be read/written.- : Partial support, see notes.
- : No support yet, but may come in future.
: No support foreseen. Out of scope.
* indicates a scheduled release that is not out yet.
DIMR¶
| Functionality | Read | Write | Supported since | API ref | Notes |
|---|---|---|---|---|---|
| DIMR | |||||
dimr_config.xml |
|
|
0.2.0 | [DIMR][hydrolib.core.io.dimr.models.DIMR] | Critical bugfix for #127. |
| FM component | |
|
0.1.1 | [FMComponent][hydrolib.core.io.dimr.models.FMComponent] | |
| RR component | |
|
0.1.1 | [RRComponent][hydrolib.core.io.dimr.models.RRComponent] | |
| RTC component | |||||
| parallel MPI models | |
|
0.1.1 | [Component][hydrolib.core.io.dimr.models.Component] | |
| coupler elements | |
|
0.1.1 | [Coupler][hydrolib.core.io.dimr.models.Coupler] |
FM¶
| Functionality | Read | Write | Supported since | API ref | Notes |
|---|---|---|---|---|---|
| FM | |||||
| MDU file | |
|
0.1.1 | [FMModel][hydrolib.core.io.mdu.models.FMModel] | |
Network file _net.nc |
|
|
0.1.1 | [Mesh2d][hydrolib.core.io.net.models.Mesh2d] | |
| Structure file | 0.1.1 | [StructureModel][hydrolib.core.io.structure.models.StructureModel] | |||
| * Weir | |
|
0.1.1 | [Weir][hydrolib.core.io.structure.models.Weir] | |
| * Universal weir | |
|
0.1.1 | [UniversalWeir][hydrolib.core.io.structure.models.UniversalWeir] | |
| * Culvert | |
|
0.1.1 | [Culvert][hydrolib.core.io.structure.models.Culvert] | |
| * Long culvert | |
|
|||
| * Bridge | |
|
0.1.5 | [Bridge][hydrolib.core.io.structure.models.Bridge] | |
| * Pump | |
|
0.1.1 | [Pump][hydrolib.core.io.structure.models.Pump] | |
| * Orifice | |
|
0.1.1 | [Orifice][hydrolib.core.io.structure.models.Orifice] | |
| * Gate | |||||
| * General structure | |
|
0.2.0 | [GeneralStructure][hydrolib.core.io.structure.models.GeneralStructure] | |
| * Dambreak | |
|
0.1.5 | [Dambreak][hydrolib.core.io.structure.models.Dambreak] | |
| * Compound structure | |
|
0.1.1 | [Compound][hydrolib.core.io.structure.models.Compound] | |
| External forcings file (old) | |
|
|||
| External forcings file (new) | |
|
0.1.1 | [ExtModel][hydrolib.core.io.ext.models.ExtModel] | |
| * Boundary | |
|
0.1.1 | [Boundary][hydrolib.core.io.ext.models.Boundary] | |
| * Lateral | |
|
0.1.1 | [Lateral][hydrolib.core.io.ext.models.Lateral] | |
| * Meteo | |||||
| * .bc file | |
|
0.1.1 | [ForcingModel][hydrolib.core.io.bc.models.ForcingModel] | |
| Cross section files | |
|
Moved to io.crosssections in 0.2.0 | ||
| Cross section definition file | |
|
0.1.1 | [CrossDefModel][hydrolib.core.io.crosssection.models.CrossDefModel] | |
| * Circle | |
|
0.1.5 | [CircleCrsDef][hydrolib.core.io.crosssection.models.CircleCrsDef] | |
| * Rectangle | |
|
0.1.5 | [RectangleCrsDef][hydrolib.core.io.crosssection.models.RectangleCrsDef] | |
| * Tabulated river | |
|
0.1.5 | [ZWRiverCrsDef][hydrolib.core.io.crosssection.models.ZWRiverCrsDef] | |
| * ZW (tabulated) | |
|
0.1.5 | [ZWCrsDef][hydrolib.core.io.crosssection.models.ZWCrsDef] | |
| * XYZ | |
|
0.1.5 | [XYZCrsDef][hydrolib.core.io.crosssection.models.XYZCrsDef] | |
| * YZ | |
|
0.1.5 | [YZCrsDef][hydrolib.core.io.crosssection.models.YZCrsDef] | |
| Cross section location file | |
|
0.1.1 | [CrossLocModel][hydrolib.core.io.crosssection.models.CrossLocModel] | |
| 1D roughness file | |
|
0.2.0 | [FrictionModel][hydrolib.core.io.friction.models.FrictionModel] | |
| Storage node file | |
|
0.2.0 | [StorageNodeModel][hydrolib.core.io.storagenode.models.StorageNodeModel] | |
| Spatial data files | |||||
| Initial and parameter field file | |
|
0.2.0 | [IniFieldModel][hydrolib.core.io.inifield.models.IniFieldModel] | |
| 1D field INI files | |
|
0.2.0 | [OneDFieldModel][hydrolib.core.io.onedfield.models.OneDFieldModel] | |
| Sample file | |
|
0.1.1 | [XYZModel][hydrolib.core.io.xyz.models.XYZModel] | |
| Output | |||||
| Observation station file (old) | |
|
|||
| Observation station file (new) | |
|
0.3.0 | [ObservationPointModel][hydrolib.core.io.obs.models.ObservationPointModel] | |
| Observation crosssection file (old) | |
|
|||
| Observation crosssection file (new) | |
|
0.3.1 | [ObservationCrossSectionModel][hydrolib.core.io.obscrosssection.models.ObservationCrossSectionModel] | |
History file _his.nc |
|||||
| Map file (old) | |
|
|||
Map file (UGRID) _map.nc |
|||||
| Fourier input file | |
|
|||
Fourier output file _fou.nc |
via map file reader | ||||
| Class map file | via map file reader |
RR¶
| Functionality | Read | Write | Supported since | API ref | Notes |
|---|---|---|---|---|---|
| RR | |||||
| Main sobek_3b.fnm | |
|
0.1.5 | [RainfallRunoffModel][hydrolib.core.io.rr.models.RainfallRunoffModel] | Used to be in hydrolib.core.io.fnm.models before 0.3.0 |
| Rainfall .bui file | |
|
0.1.5 | [BuiModel][hydrolib.core.io.rr.meteo.models.BuiModel] | Used to be in hydrolib.core.io.bui.models before 0.3.0 |
| Topology layer | |||||
| Node file 3b_node.tp | |
|
0.2.0 | [NodeFile][hydrolib.core.io.rr.topology.models.NodeFile] | |
| Link file 3b_link.tp | |
|
0.2.0 | [LinkFile][hydrolib.core.io.rr.topology.models.LinkFile] |
(Table source available on: https://github.com/Deltares/HYDROLIB-core/blob/main/docs/topics/dhydro_support_hydrolib-core.xlsx)