API Reference
Main
| open | Open a file type supported by MIKE IO 1D file. |
| Res1D | Class for reading data from 1D network result files. |
| Xns11 | A class to read and write xns11 files. |
Locations
| result_network.ResultLocation | A base class for a network location (node, reach) or a catchment wrapper class. |
| result_network.ResultLocations | A base class for a network locations (nodes, reaches) or a catchments wrapper class. |
| result_network.ResultNode | Class for wrapping a single ResultData node. |
| result_network.ResultNodes | Class for wrapping ResultData nodes. |
| result_network.ResultReach | Class for wrapping a list of ResultData reaches having the same reach name. |
| result_network.ResultReaches | Class for wrapping ResultData reaches. |
| result_network.ResultGridPoint | Class for wrapping a single ResultData grid point. |
| result_network.ResultCatchment | Class for wrapping a single ResultData catchment. |
| result_network.ResultCatchments | Class for wrapping ResultData catchments. |
| result_network.ResultGlobalData | Class for wrapping ResultData global data items. |
| result_network.ResultGlobalDatas | Class for wrapping ResultData global data items. |
| result_network.ResultStructure | Class for wrapping a list of ResultData structure data items belonging to the same structure. |
| result_network.ResultStructures | Class for wrapping ResultData structure data items. |
Quantities
| result_network.ResultQuantity | Class for wrapping a single ResultData data item quantity. |
| result_network.ResultQuantityCollection | Class for dealing with a collection ResultQuantity objects. |
Cross sections
| cross_sections.CrossSection | A cross section in MIKE 1D, uniquely identified by a location ID, chainage, and topo ID. |
| cross_sections.CrossSectionCollection | A collection of CrossSection objects. |
| cross_sections.Marker | The standard markers used in cross sections. |
| cross_sections.ProcessLevelsMethod | How to generate processing levels. |
| cross_sections.RadiusType | The type of hydraulic radius to use in the cross section. |
| cross_sections.ResistanceDistribution | The type of resistance distribution used in the cross section. |
| cross_sections.ResistanceType | The type of resistance used in the cross section. |
Geometry
Returned by the geometry property of locations and cross sections.
| geometry.NodePoint | A utility class for working with node geometries. |
| geometry.ReachPoint | A utility class for working with points along a reach. |
| geometry.ReachGeometry | A utility class for working with reach geometries. |
| geometry.CatchmentGeometry | A utility class for working with catchment geometries. |
| geometry.CrossSectionGeometry | A utility class for working with cross section geometries. |
Pandas extension
Available on DataFrames as the m1d accessor once mikeio1d is imported.
| pandas_extension.Mikeio1dAccessor | Uses Pandas Extension API to register a custom accessor for DataFrames. |
| pandas_extension.ResultFrameAggregator | Aggregates a MIKE IO 1D result DataFrame with hierarchical columns along specific levels. |
| pandas_extension.TransposedGroupBy | Same as pandas.DataFrameGroupBy, but returns the transpose of the result. |
| pandas_extension.agg_chainage | Aggregate results along the chainage axis. |
| pandas_extension.groupby_chainage | Group results for aggregation along the chainage axis. |
| pandas_extension.compact_dataframe | Convert a DataFrame with a hierarchical column index to a compact DataFrame. |
| pandas_extension.groupby_level | Group DataFrame for aggregations along the specific level name. |
Network
Needs the network extra.
| network.Network | A network of nodes and reaches, addressable by the names it came with. |
| network.Address | A location under the name its model gave it. |
| network.NetworkLocation | A location a network has, as :meth:Network.resolve answers for it. |
| network.NetworkReach | A directed connection between two nodes, and the breakpoints along it. |
Experimental
Not part of the stable API: may change or be removed at any time.
| experimental.to_networkx | Convert a Res1D object to a networkx Graph. |
| experimental.to_dataarray | Convert a Res1D object to an xarray DataArray. |
| experimental.to_dataarray_xvec | Convert a Res1D object to an xarray DataArray with an xvec GeometryIndex. |