MetaSWAP#

Model objects & methods#

`MetaSwapModel`(unsaturated_database[, settings])	Contains data and writes consistent model input files
`MetaSwapModel.write`(directory, mf6_dis, mf6_wel)	Write packages and simulation settings (para_sim.inp).
`MetaSwapModel.from_imod5_data`(imod5_data, ...)	Construct a MetaSWAP model from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`MetaSwapModel.regrid_like`(mf6_regridded_dis)	Creates a model by regridding the packages of this model to another discretization.
`MetaSwapModel.clip_box`([time_min, time_max, ...])	Clip a model by a bounding box (time, y, x).
`MetaSwapModel.get_pkgkey`(pkg_type[, ...])	Get the package key for a package of type `pkg_type`.

Packages#

Grid packages#

`GridData`(area, landuse, rootzone_depth, ...)	This contains the grid data of MetaSWAP.
`GridData.regrid_like`(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
`GridData.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`GridData.from_imod5_data`(imod5_data, target_dis)	Construct a MetaSWAP GridData package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`GridData.get_regrid_methods`()	Returns the default regrid methods for this package.
`GridData.generate_index_array`()	Generate index array and svat grid to be used on other packages.
`GridData.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`Infiltration`(infiltration_capacity, ...)	This contains the infiltration data.
`Infiltration.regrid_like`(target_grid, ...[, ...])	Creates a package of the same type as this package, based on another discretization.
`Infiltration.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`Infiltration.from_imod5_data`(imod5_data)	Construct a MetaSWAP Infiltration package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`Infiltration.get_regrid_methods`()	Returns the default regrid methods for this package.
`Infiltration.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`Ponding`(ponding_depth, runon_resistance, ...)	Set ponding related parameters for MetaSWAP.
`Ponding.regrid_like`(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
`Ponding.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`Ponding.from_imod5_data`(imod5_data)	Construct a MetaSWAP Ponding package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`Ponding.get_regrid_methods`()	Returns the default regrid methods for this package.
`Ponding.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`ScalingFactors`(scale_soil_moisture, ...)	This package allows you to do three things:
`ScalingFactors.regrid_like`(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
`ScalingFactors.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`ScalingFactors.from_imod5_data`(imod5_data)	Construct a MetaSWAP Ponding package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`ScalingFactors.get_regrid_methods`()	Returns the default regrid methods for this package.
`ScalingFactors.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`Sprinkling`(max_abstraction_groundwater, ...)	This contains the sprinkling capacities of links between SVAT units and groundwater/surface water locations.
`Sprinkling.regrid_like`(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
`Sprinkling.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`Sprinkling.from_imod5_data`(imod5_data)	Import sprinkling data from imod5 data.
`Sprinkling.get_regrid_methods`()	Returns the default regrid methods for this package.
`Sprinkling.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.

Initial conditions#

`InitialConditionsEquilibrium`()	Use an equilibrium profile to initialize the model.
`InitialConditionsEquilibrium.regrid_like`(...)	Creates a package of the same type as this package, based on another discretization.
`InitialConditionsEquilibrium.clip_box`([...])	Clip a package by a bounding box (time, y, x).
`InitialConditionsEquilibrium.from_imod5_data`(...)	This package cannot be constructed from iMOD5 data.
`InitialConditionsEquilibrium.get_regrid_methods`()	Returns the default regrid methods for this package.
`InitialConditionsEquilibrium.write`(...)	Write MetaSWAP package to its corresponding fixed format file.
`InitialConditionsPercolation`()	The precipitation intensity at the starting time (iybg, tdbg in PARA_SIM.INP) is used for initializing the percolation flux in the profiles.
`InitialConditionsPercolation.regrid_like`(...)	Creates a package of the same type as this package, based on another discretization.
`InitialConditionsPercolation.clip_box`([...])	Clip a package by a bounding box (time, y, x).
`InitialConditionsPercolation.from_imod5_data`(...)	This package cannot be constructed from iMOD5 data.
`InitialConditionsPercolation.get_regrid_methods`()	Returns the default regrid methods for this package.
`InitialConditionsPercolation.write`(...)	Write MetaSWAP package to its corresponding fixed format file.
`InitialConditionsRootzonePressureHead`([...])	Use the pF-value of the root zone pressure head as initial condition.
`InitialConditionsRootzonePressureHead.regrid_like`(...)	Creates a package of the same type as this package, based on another discretization.
`InitialConditionsRootzonePressureHead.clip_box`([...])	Clip a package by a bounding box (time, y, x).
`InitialConditionsRootzonePressureHead.from_imod5_data`(...)	This package cannot be constructed from iMOD5 data.
`InitialConditionsRootzonePressureHead.get_regrid_methods`()	Returns the default regrid methods for this package.
`InitialConditionsRootzonePressureHead.write`(...)	Write MetaSWAP package to its corresponding fixed format file.
`InitialConditionsSavedState`(saved_state)	Use saved state of a previous MetaSWAP run as initial condition.
`InitialConditionsSavedState.regrid_like`(...)	Creates a package of the same type as this package, based on another discretization.
`InitialConditionsSavedState.clip_box`([...])	Clip a package by a bounding box (time, y, x).
`InitialConditionsSavedState.from_imod5_data`(...)	This package cannot be constructed from iMOD5 data.
`InitialConditionsSavedState.get_regrid_methods`()	Returns the default regrid methods for this package.
`InitialConditionsSavedState.write`(directory, ...)	Write MetaSWAP package to its corresponding fixed format file.

Output control#

`IdfMapping`(area, nodata)	Describes svat location in the IDF grid.
`IdfMapping.regrid_like`(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
`IdfMapping.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`IdfMapping.from_imod5_data`(args, *kwargs)	This package cannot be constructed from iMOD5 data.
`IdfMapping.get_regrid_methods`()	Returns the default regrid methods for this package.
`IdfMapping.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`TimeOutputControl`(time)	Specify the accumulation periods which will be used to write output.
`TimeOutputControl.regrid_like`(target_grid, ...)	Returns a deepcopy of this instance, as regridding this package is irrelevant: TimeOutputcontrol does not depend on the grid.
`TimeOutputControl.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`TimeOutputControl.from_imod5_data`(*args, ...)	This package cannot be constructed from iMOD5 data.
`TimeOutputControl.get_regrid_methods`()	Returns the default regrid methods for this package.
`TimeOutputControl.write`(directory, index, ...)	Write MetaSWAP package to its corresponding fixed format file.
`VariableOutputControl`([Pm, Psgw, Pssw, ...])	Control which variables will be created as output.
`VariableOutputControl.regrid_like`(...[, ...])	Creates a package of the same type as this package, based on another discretization.
`VariableOutputControl.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`VariableOutputControl.from_imod5_data`(*args, ...)	This package cannot be constructed from iMOD5 data.
`VariableOutputControl.get_regrid_methods`()	Returns the default regrid methods for this package.
`VariableOutputControl.write`(directory, ...)	Write MetaSWAP package to its corresponding fixed format file.

Parameter packages#

`LanduseOptions`(landuse_name, ...[, ...])	Land use options.
`LanduseOptions.regrid_like`(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
`LanduseOptions.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`LanduseOptions.from_imod5_data`(args, *kwargs)	This package cannot be constructed from iMOD5 data.
`LanduseOptions.get_regrid_methods`()	Returns the default regrid methods for this package.
`LanduseOptions.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.
`AnnualCropFactors`(soil_cover, ...)	For each vegetation type specify a yearly trend in vegetation factors and interception characteristics.
`AnnualCropFactors.regrid_like`(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
`AnnualCropFactors.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`AnnualCropFactors.from_imod5_data`(*args, ...)	This package cannot be constructed from iMOD5 data.
`AnnualCropFactors.get_regrid_methods`()	Returns the default regrid methods for this package.
`AnnualCropFactors.write`(directory, index, ...)	Write MetaSWAP package to its corresponding fixed format file.

Meteorology packages#

`MeteoGrid`(precipitation, evapotranspiration)	This contains the meteorological grid data.
`MeteoGrid.regrid_like`(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
`MeteoGrid.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`MeteoGrid.from_imod5_data`(args, *kwargs)	This package cannot be constructed from iMOD5 data.
`MeteoGrid.get_regrid_methods`()	Returns the default regrid methods for this package.
`MeteoGrid.write`(directory, *args)	Write mete_grid.inp and accompanying ASCII grid files.
`MeteoGridCopy`(path)	Class to copy existing `mete_grid.inp`, which contains the meteorological grid data.
`MeteoGridCopy.regrid_like`(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
`MeteoGridCopy.clip_box`([time_min, time_max, ...])	Clip a package by a bounding box (time, y, x).
`MeteoGridCopy.from_imod5_data`(imod5_data)	Construct a MetaSWAP MeteoGridCopy package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`MeteoGridCopy.get_regrid_methods`()	Returns the default regrid methods for this package.
`MeteoGridCopy.write`(directory, *args)	Write MetaSWAP package to its corresponding fixed format file.
`EvapotranspirationMapping`(evapotranspiration)	This contains the data to connect evapotranspiration grid cells to MetaSWAP svats.
`EvapotranspirationMapping.regrid_like`(...[, ...])	Returns a deepcopy of this instance, as regridding this package is irrelevant: The meteo data is not on model grid and the mapping is determined upon writing.
`EvapotranspirationMapping.clip_box`([...])	Clip a package by a bounding box (time, y, x).
`EvapotranspirationMapping.from_imod5_data`(...)	Construct a MetaSWAP EvapotranspirationMapping package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`EvapotranspirationMapping.get_regrid_methods`()	Returns the default regrid methods for this package.
`EvapotranspirationMapping.write`(directory, ...)	Write MetaSWAP package to its corresponding fixed format file.
`PrecipitationMapping`(precipitation)	This contains the data to connect precipitation grid cells to MetaSWAP svats.
`PrecipitationMapping.regrid_like`(...[, ...])	Returns a deepcopy of this instance, as regridding this package is irrelevant: The meteo data is not on model grid and the mapping is determined upon writing.
`PrecipitationMapping.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`PrecipitationMapping.from_imod5_data`(imod5_data)	Construct a MetaSWAP PrecipitationMapping package from iMOD5 data in the CAP package, loaded with the `imod.formats.prj.open_projectfile_data()` function.
`PrecipitationMapping.get_regrid_methods`()	Returns the default regrid methods for this package.
`PrecipitationMapping.write`(directory, index, ...)	Write MetaSWAP package to its corresponding fixed format file.

Mappings#

`CouplerMapping`()	This contains the data to connect MODFLOW 6 cells to MetaSWAP svats.
`CouplerMapping.regrid_like`(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
`CouplerMapping.clip_box`([time_min, ...])	Clip a package by a bounding box (time, y, x).
`CouplerMapping.from_imod5_data`(args, *kwargs)	This package cannot be constructed from iMOD5 data.
`CouplerMapping.get_regrid_methods`()	Returns the default regrid methods for this package.
`CouplerMapping.write`(directory, index, svat, ...)	Write MetaSWAP package to its corresponding fixed format file.