API Reference#
This page provides an auto-generated summary of imod’s API.
- Changelog
- [0.18.1] - 2024-11-20
- [0.18.0] - 2024-11-11
- [0.17.2] - 2024-09-17
- [0.17.1] - 2024-05-16
- [0.17.0] - 2024-05-13
- [0.16.0] - 2024-03-29
- [0.15.3] - 2024-02-22
- [0.15.2] - 2024-02-16
- [0.15.1] - 2023-12-22
- [0.15.0] - 2023-11-25
- [0.14.1] - 2023-09-07
- [0.14.0] - 2023-09-06
- [0.13.2] - 2023-07-26
- [0.13.1] - 2023-05-05
- [0.13.0] - 2023-05-02
- [0.12.0] - 2023-03-17
- [0.11.6] - 2023-02-01
- [0.11.5] - 2022-12-15
- [0.11.4] - 2022-09-05
- [0.11.1] - 2021-12-23
- [0.11.0] - 2021-12-21
- [0.10.1] - 2020-10-19
- [0.10.0] - 2020-05-23
- [0.9.0] - 2020-01-19
- [0.8.0] - 2019-10-14
- [0.7.1] - 2019-08-07
- [0.7.0] - 2019-07-23
- [0.6.1] - 2019-04-17
- [0.6.0] - 2019-03-15
- [0.5.0] - 2019-02-26
- Input/output
- imod.formats.idf.open
- imod.formats.idf.open_dataset
- imod.formats.idf.open_subdomains
- imod.formats.idf.save
- imod.formats.idf.header
- imod.formats.ipf.read
- imod.formats.ipf.read_associated
- imod.formats.ipf.save
- imod.formats.ipf.write
- imod.formats.ipf.write_assoc
- imod.formats.rasterio.header
- imod.formats.rasterio.open
- imod.formats.rasterio.save
- imod.formats.gen.read
- imod.formats.gen.write
- imod.formats.gen.read_ascii
- imod.formats.prj.read_projectfile
- imod.formats.prj.open_projectfile_data
- imod.formats.prj.read_timfile
- Prepare model input
- imod.prepare.Regridder
- imod.prepare.LayerRegridder
- imod.prepare.Voxelizer
- imod.prepare.fill
- imod.prepare.laplace_interpolate
- imod.prepare.polygonize
- imod.prepare.reproject
- imod.prepare.rasterize
- imod.prepare.gdal_rasterize
- imod.prepare.celltable
- imod.prepare.rasterize_celltable
- imod.prepare.zonal_aggregate_polygons
- imod.prepare.zonal_aggregate_raster
- imod.prepare.linestring_to_square_zpolygons
- imod.prepare.linestring_to_trapezoid_zpolygons
- imod.prepare.assign_wells
- imod.prepare.get_lower_active_grid_cells
- imod.prepare.get_lower_active_layer_number
- imod.prepare.get_upper_active_grid_cells
- imod.prepare.get_upper_active_layer_number
- imod.prepare.create_layered_top
- imod.prepare.ALLOCATION_OPTION
- imod.prepare.DISTRIBUTING_OPTION
- imod.prepare.allocate_drn_cells
- imod.prepare.allocate_ghb_cells
- imod.prepare.allocate_rch_cells
- imod.prepare.allocate_riv_cells
- imod.prepare.c_leakage
- imod.prepare.c_radial
- imod.prepare.distribute_drn_conductance
- imod.prepare.distribute_ghb_conductance
- imod.prepare.distribute_riv_conductance
- imod.prepare.cleanup_drn
- imod.prepare.cleanup_ghb
- imod.prepare.cleanup_riv
- imod.prepare.cleanup_wel
- Select points and cross sections
- Evaluate model output
- imod.evaluate.calculate_gxg
- imod.evaluate.convert_pointwaterhead_freshwaterhead
- imod.evaluate.facebudget
- imod.evaluate.flow_velocity
- imod.evaluate.interpolate_value_boundaries
- imod.evaluate.quiver_line
- imod.evaluate.quiver_linestring
- imod.evaluate.streamfunction_line
- imod.evaluate.streamfunction_linestring
- imod.evaluate.intra_cell_boundary_conditions
- imod.evaluate.stability_constraint_advection
- imod.evaluate.stability_constraint_wel
- Visualize
- imod.visualize.cross_section
- imod.visualize.plot_map
- imod.visualize.imshow_topview
- imod.visualize.read_imod_legend
- imod.visualize.quiver
- imod.visualize.streamfunction
- imod.visualize.waterbalance_barchart
- imod.visualize.grid_3d
- imod.visualize.line_3d
- imod.visualize.GridAnimation3D
- imod.visualize.StaticGridAnimation3D
- Utilities
- imod.util.empty_2d
- imod.util.empty_2d_transient
- imod.util.empty_3d
- imod.util.empty_3d_transient
- imod.util.where
- imod.util.cd
- imod.util.ignore_warnings
- imod.util.print_if_error
- imod.util.to_datetime
- imod.util.coord_reference
- imod.util.spatial_reference
- imod.util.transform
- imod.util.to_ugrid2d
- imod.util.mdal_compliant_ugrid2d
- imod.util.from_mdal_compliant_ugrid2d
- Logging
- MODFLOW6
- Regrid
- iMOD-WQ
- iMODFLOW
- MetaSWAP
- imod.msw.GridData
- imod.msw.Infiltration
- imod.msw.Ponding
- imod.msw.ScalingFactors
- imod.msw.Sprinkling
- imod.msw.IdfMapping
- imod.msw.TimeOutputControl
- imod.msw.VariableOutputControl
- imod.msw.InitialConditionsEquilibrium
- imod.msw.InitialConditionsPercolation
- imod.msw.InitialConditionsRootzonePressureHead
- imod.msw.InitialConditionsSavedState
- imod.msw.LanduseOptions
- imod.msw.AnnualCropFactors
- imod.msw.MeteoGrid
- imod.msw.EvapotranspirationMapping
- imod.msw.PrecipitationMapping
- imod.msw.CouplerMapping
- imod.msw.MetaSwapModel
- MetaMod