MODFLOW 6

Read Output

open_hds(hds_path, grb_path[, dry_nan, ...])	Open modflow6 heads (.hds) file.
open_cbc(cbc_path, grb_path[, flowja, ...])	Open modflow6 cell-by-cell (.cbc) file.
read_cbc_headers(cbc_path)	Read all the header data from a cell-by-cell (.cbc) budget file.
open_dvs(dvs_path, grb_path, indices[, ...])	Open modflow6 dependent variable output for complex packages (like the watercontent file for the UZF-package).
open_conc(ucn_path, grb_path[, dry_nan, ...])	Open Modflow6 "Unformatted Concentration" (.ucn) file.
read_grb(path)	Read the data in a MODFLOW6 binary grid (.grb) file.

Model objects & methods

Modflow6Simulation(name[, validation_settings])	Modflow6Simulation is a class that represents a Modflow 6 simulation.
Modflow6Simulation.create_time_discretization(...)	Collect all unique times from model packages and additional given times.
Modflow6Simulation.copy()
Modflow6Simulation.write([directory, ...])	Write Modflow6 simulation, including assigned groundwater flow and transport models.
Modflow6Simulation.dump([directory, ...])	Dump simulation to files.
Modflow6Simulation.run([mf6path])	Run Modflow 6 simulation.
Modflow6Simulation.mask_all_models(mask)	This function applies a mask to all models in a simulation, provided they use the same discretization.
Modflow6Simulation.open_flow_budget([...])	Open flow budgets of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_transport_budget([...])	Open transport budgets of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_head([dry_nan, ...])	Open heads of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_concentration([...])	Open concentration of finished simulation, requires that the run method has been called.
Modflow6Simulation.from_file(toml_path)	Load Modflow6Simulation, previously dumped to TOML file with imod.mf6.Modflow6Simulation.dump() from a TOML file.
Modflow6Simulation.from_imod5_data(...[, ...])	Imports a GroundwaterFlowModel (GWF) from the data in an iMOD5 project file and puts it in a simulation.
Modflow6Simulation.clip_box([time_min, ...])	Clip a simulation by a bounding box (time, layer, y, x).
Modflow6Simulation.split(submodel_labels[, ...])	Split a simulation in different partitions using a submodel_labels array.
Modflow6Simulation.regrid_like(...[, validate])	This method creates a new simulation object.
Modflow6Simulation.is_split()	Check if the simulation is split into multiple partitions.
Modflow6Simulation.get_exchange_relationships()	Get exchange relationships in the simulation.
Modflow6Simulation.get_models_of_type(model_id)	Get all models in the simulation of a specific type.
Modflow6Simulation.get_models()	Get all models in the simulation.
Modflow6Simulation.create_partition_labels(...)	Returns a label array: a 2d array with a similar size to the top layer of idomain.
GroundwaterFlowModel([listing_file, ...])	The GroundwaterFlowModel (GWF) simulates flow of (liquid) groundwater.
GroundwaterFlowModel.mask_all_packages(mask)	This function applies a mask to all packages in a model.
GroundwaterFlowModel.prepare_wel_for_mf6(pkgname)	Prepare grid-agnostic well for MODFLOW6, using the models grid information and hydraulic conductivities.
GroundwaterFlowModel.regrid_like(target_grid)	Creates a model by regridding the packages of this model to another discretization.
GroundwaterFlowModel.dump(directory, modelname)	Dump simulation to files.
GroundwaterFlowModel.from_imod5_data(...[, ...])	Imports a GroundwaterFlowModel (GWF) from the data in an iMOD5 project file and puts it in a simulation.
GroundwaterFlowModel.clip_box([time_min, ...])	Clip a model by a bounding box (time, layer, y, x).
GroundwaterFlowModel.from_file(toml_path)
GroundwaterFlowModel.purge_empty_packages([...])	This method removes empty packages from the model in place.
GroundwaterFlowModel.is_use_newton()	Returns whether the Newton-Raphson formulation is used for groundwater flow between connected, convertible groundwater cells.
GroundwaterFlowModel.validate([model_name, ...])	Validate model.
GroundwaterFlowModel.set_newton(is_newton)	Sets whether the Newton-Raphson formulation is used for groundwater flow between connected, convertible groundwater cells.
GroundwaterFlowModel.write(modelname, ...[, ...])	Write MODFLOW6 model to file.
GroundwaterFlowModel.get_diskey()	Get discretization key from the model.
GroundwaterTransportModel([listing_file, ...])	The GroundwaterTransportModel (GWT) simulates transport of a single solute species flowing in groundwater.
GroundwaterTransportModel.mask_all_packages(mask)	This function applies a mask to all packages in a model.
GroundwaterTransportModel.dump(directory, ...)	Dump simulation to files.
GroundwaterTransportModel.clip_box([...])	Clip a model by a bounding box (time, layer, y, x).
GroundwaterTransportModel.regrid_like(...[, ...])	Creates a model by regridding the packages of this model to another discretization.
GroundwaterTransportModel.from_file(toml_path)
GroundwaterTransportModel.purge_empty_packages([...])	This method removes empty packages from the model in place.
GroundwaterTransportModel.validate([...])	Validate model.
GroundwaterTransportModel.is_use_newton()	Returns whether the Newton-Raphson formulation is used for groundwater flow between connected, convertible groundwater cells.
GroundwaterTransportModel.write(modelname, ...)	Write MODFLOW6 model to file.
GroundwaterTransportModel.get_diskey()	Get discretization key from the model.

Discretization

StructuredDiscretization(*_, **__)	Discretization information for structered grids is specified using the file.
StructuredDiscretization.from_imod5_data(...)	Construct package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
StructuredDiscretization.get_regrid_methods()	Returns the default regrid methods for this package.
StructuredDiscretization.regrid_like(...[, ...])	Regrid discretization package.
StructuredDiscretization.from_file(path, ...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
StructuredDiscretization.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
StructuredDiscretization.copy()	Copy package into a new package of the same type.
StructuredDiscretization.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
StructuredDiscretization.mask(mask)	Mask values outside of domain.
StructuredDiscretization.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
StructuredDiscretization.write(pkgname, ...)	Write package to file
VerticesDiscretization(*_, **__)	Discretization by Vertices (DISV).
VerticesDiscretization.get_regrid_methods()	Returns the default regrid methods for this package.
VerticesDiscretization.regrid_like(...[, ...])	Creates a package of the same type as this package, based on another discretization.
VerticesDiscretization.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
VerticesDiscretization.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
VerticesDiscretization.copy()	Copy package into a new package of the same type.
VerticesDiscretization.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
VerticesDiscretization.mask(mask)	Mask values outside of domain.
VerticesDiscretization.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
VerticesDiscretization.write(pkgname, ...[, ...])	Write package to file
TimeDiscretization(*_, **__)	Timing for all models of the simulation is controlled by the Temporal Discretization (TDIS) Package.
TimeDiscretization.write(pkgname, ...[, ...])	Write package to file
TimeDiscretization.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
TimeDiscretization.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
TimeDiscretization.copy()	Copy package into a new package of the same type.
TimeDiscretization.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
TimeDiscretization.mask(mask)	Mask values outside of domain.
TimeDiscretization.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
TimeDiscretization.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
TimeDiscretization.get_regrid_methods()	Returns the default regrid methods for this package.
AdaptiveTimeStepping(*_, **__)	Adaptive Time Stepping (ATS) Package for MODFLOW 6.
AdaptiveTimeStepping.write(pkgname, ...[, ...])	Write package to file
AdaptiveTimeStepping.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
AdaptiveTimeStepping.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
AdaptiveTimeStepping.copy()	Copy package into a new package of the same type.
AdaptiveTimeStepping.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
AdaptiveTimeStepping.mask(mask)	Mask values outside of domain.
AdaptiveTimeStepping.regrid_like(...[, ...])	Creates a package of the same type as this package, based on another discretization.
AdaptiveTimeStepping.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
AdaptiveTimeStepping.get_regrid_methods()	Returns the default regrid methods for this package.

Model settings

OutputControl(*_, **__)	The Output Control Option determines how and when heads, budgets and/or concentrations are printed to the listing file and/or written to a separate binary output file.
OutputControl.is_budget_output
OutputControl.write(pkgname, globaltimes, ...)	Write package to file
OutputControl.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
OutputControl.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
OutputControl.copy()	Copy package into a new package of the same type.
OutputControl.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
OutputControl.mask(mask)	Mask values outside of domain.
OutputControl.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
OutputControl.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
OutputControl.get_regrid_methods()	Returns the default regrid methods for this package.
Solution(*_, **__)	Iterative Model Solution.
Solution.write(pkgname, globaltimes, directory)	Write package to file
Solution.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Solution.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
Solution.copy()	Copy package into a new package of the same type.
Solution.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
Solution.mask(mask)	Mask values outside of domain.
Solution.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
Solution.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Solution.get_regrid_methods()	Returns the default regrid methods for this package.
SolutionPresetSimple(modelnames[, ...])	Preset solution for simple models, where small mass balance errors are wanted.
SolutionPresetModerate(modelnames[, ...])	Preset solution for models of moderate complexity.
SolutionPresetComplex(modelnames[, ...])	Preset solution for models of large complexity.
ValidationSettings([validate, ...])	Validation settings for MF6 model validation.

Flow Packages

ApiPackage(*_, **__)	The API package can be used to interact with the dll-version of Modflow (libMF6.dll).
ApiPackage.write(pkgname, globaltimes, directory)	Write package to file
ApiPackage.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
ApiPackage.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
ApiPackage.copy()	Copy package into a new package of the same type.
ApiPackage.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
ApiPackage.get_regrid_methods()	Returns the default regrid methods for this package.
ApiPackage.mask(mask)	Mask values outside of domain.
ApiPackage.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
ApiPackage.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
Buoyancy(*_, **__)	Buoyancy package.
Buoyancy.write(pkgname, globaltimes, directory)	Write package to file
Buoyancy.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Buoyancy.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
Buoyancy.copy()	Copy package into a new package of the same type.
Buoyancy.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Buoyancy.get_regrid_methods()	Returns the default regrid methods for this package.
Buoyancy.mask(mask)	Mask values outside of domain.
Buoyancy.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
Buoyancy.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
ConstantHead(*_, **__)	Constant-Head package.
ConstantHead.from_imod5_data(key, ...[, ...])	Construct a ConstantHead-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
ConstantHead.from_imod5_shd_data(imod5_data, ...)	Construct a ConstantHead-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
ConstantHead.mask(mask)	Mask values outside of domain.
ConstantHead.regrid_like(target_grid, ...[, ...])	Creates a package of the same type as this package, based on another discretization.
ConstantHead.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
ConstantHead.write(pkgname, globaltimes, ...)	Write package to file
ConstantHead.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
ConstantHead.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
ConstantHead.copy()	Copy package into a new package of the same type.
ConstantHead.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
ConstantHead.get_regrid_methods()	Returns the default regrid methods for this package.
Drainage(*_, **__)	The Drain package is used to simulate head-dependent flux boundaries.
Drainage.mask(mask)	Mask values outside of domain.
Drainage.from_imod5_data(key, imod5_data, ...)	Construct a drainage-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
Drainage.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
Drainage.cleanup(dis)	Clean up package inplace.
Drainage.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
Drainage.write(pkgname, globaltimes, directory)	Write package to file
Drainage.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Drainage.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
Drainage.copy()	Copy package into a new package of the same type.
Drainage.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Drainage.get_regrid_methods()	Returns the default regrid methods for this package.
Drainage.aggregate_layers(dataset)	Aggregate data over layers into planar dataset.
Drainage.reallocate(dis[, npf, ...])	Reallocates topsystem data across layers and create new package with it.
Evapotranspiration(*_, **__)	Evapotranspiration (EVT) Package.
Evapotranspiration.mask(mask)	Mask values outside of domain.
Evapotranspiration.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
Evapotranspiration.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
Evapotranspiration.write(pkgname, ...[, ...])	Write package to file
Evapotranspiration.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Evapotranspiration.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
Evapotranspiration.copy()	Copy package into a new package of the same type.
Evapotranspiration.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Evapotranspiration.get_regrid_methods()	Returns the default regrid methods for this package.
GeneralHeadBoundary(*_, **__)	The General-Head Boundary package is used to simulate head-dependent flux boundaries.
GeneralHeadBoundary.from_imod5_data(key, ...)	Construct a GeneralHeadBoundary-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
GeneralHeadBoundary.mask(mask)	Mask values outside of domain.
GeneralHeadBoundary.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
GeneralHeadBoundary.cleanup(dis)	Clean up package inplace.
GeneralHeadBoundary.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
GeneralHeadBoundary.write(pkgname, ...[, ...])	Write package to file
GeneralHeadBoundary.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
GeneralHeadBoundary.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
GeneralHeadBoundary.copy()	Copy package into a new package of the same type.
GeneralHeadBoundary.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
GeneralHeadBoundary.get_regrid_methods()	Returns the default regrid methods for this package.
GeneralHeadBoundary.aggregate_layers(dataset)	Aggregate data over layers into planar dataset.
GeneralHeadBoundary.reallocate(dis[, npf, ...])	Reallocates topsystem data across layers and create new package with it.
HorizontalFlowBarrierHydraulicCharacteristic(*_, ...)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierHydraulicCharacteristic.clip_box([...])	Clip a barrier by a bounding box (y, x).
HorizontalFlowBarrierHydraulicCharacteristic.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierHydraulicCharacteristic.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
HorizontalFlowBarrierHydraulicCharacteristic.write(...)	Write package to file
HorizontalFlowBarrierHydraulicCharacteristic.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
HorizontalFlowBarrierHydraulicCharacteristic.to_netcdf(*args)	Write dataset contents to a netCDF file.
HorizontalFlowBarrierHydraulicCharacteristic.copy()	Copy package into a new package of the same type.
HorizontalFlowBarrierHydraulicCharacteristic.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
HorizontalFlowBarrierHydraulicCharacteristic.get_regrid_methods()	Returns the default regrid methods for this package.
HorizontalFlowBarrierHydraulicCharacteristic.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
HorizontalFlowBarrierHydraulicCharacteristic.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
HorizontalFlowBarrierMultiplier(*_, **__)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierMultiplier.clip_box([...])	Clip a barrier by a bounding box (y, x).
HorizontalFlowBarrierMultiplier.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierMultiplier.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
HorizontalFlowBarrierMultiplier.write(...[, ...])	Write package to file
HorizontalFlowBarrierMultiplier.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
HorizontalFlowBarrierMultiplier.to_netcdf(*args)	Write dataset contents to a netCDF file.
HorizontalFlowBarrierMultiplier.copy()	Copy package into a new package of the same type.
HorizontalFlowBarrierMultiplier.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
HorizontalFlowBarrierMultiplier.get_regrid_methods()	Returns the default regrid methods for this package.
HorizontalFlowBarrierMultiplier.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
HorizontalFlowBarrierMultiplier.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
HorizontalFlowBarrierResistance(*_, **__)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierResistance.cleanup(dis)	Cleanup the package inplace by removing barriers that fall outside of the active model domain.
HorizontalFlowBarrierResistance.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierResistance.clip_box([...])	Clip a barrier by a bounding box (y, x).
HorizontalFlowBarrierResistance.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
HorizontalFlowBarrierResistance.write(...[, ...])	Write package to file
HorizontalFlowBarrierResistance.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
HorizontalFlowBarrierResistance.to_netcdf(*args)	Write dataset contents to a netCDF file.
HorizontalFlowBarrierResistance.copy()	Copy package into a new package of the same type.
HorizontalFlowBarrierResistance.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
HorizontalFlowBarrierResistance.get_regrid_methods()	Returns the default regrid methods for this package.
HorizontalFlowBarrierResistance.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
HorizontalFlowBarrierResistance.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
LayeredWell(*_, **__)	Agnostic WEL package, which accepts x, y and layers.
LayeredWell.from_imod5_data(key, imod5_data, ...)	Convert wells to imod5 data, loaded with imod.formats.prj.open_projectfile_data(), to a Well object.
LayeredWell.from_imod5_cap_data(imod5_data)	Create LayeredWell from imod5_data in "cap" package.
LayeredWell.cleanup(dis)	Clean up package inplace.
LayeredWell.mask(domain)	Mask wells based on two-dimensional domain.
LayeredWell.regrid_like(target_grid, ...[, ...])	Creates a package of the same type as this package, based on another discretization.
LayeredWell.to_mf6_pkg(active, top, bottom, k)	Write package to Modflow 6 package.
LayeredWell.clip_box([time_min, time_max, ...])	Clip a well package by a bounding box (time, layer, y, x).
LayeredWell.write(pkgname, globaltimes, ...)	Write package to file
LayeredWell.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
LayeredWell.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
LayeredWell.copy()	Copy package into a new package of the same type.
LayeredWell.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
LayeredWell.get_regrid_methods()	Returns the default regrid methods for this package.
InitialConditions(*_, **__)	Initial Conditions (IC) Package information is read from the file that is specified by "IC6" as the file type.
InitialConditions.from_imod5_data(...[, ...])	Construct an InitialConditions-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
InitialConditions.mask(mask)	Mask values outside of domain.
InitialConditions.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
InitialConditions.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
InitialConditions.write(pkgname, ...[, ...])	Write package to file
InitialConditions.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
InitialConditions.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
InitialConditions.copy()	Copy package into a new package of the same type.
InitialConditions.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
InitialConditions.get_regrid_methods()	Returns the default regrid methods for this package.
NodePropertyFlow(*_, **__)	Node Property Flow package.
NodePropertyFlow.from_imod5_data(imod5_data, ...)	Construct an npf-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
NodePropertyFlow.mask(mask)	Mask values outside of domain.
NodePropertyFlow.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
NodePropertyFlow.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
NodePropertyFlow.write(pkgname, globaltimes, ...)	Write package to file
NodePropertyFlow.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
NodePropertyFlow.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
NodePropertyFlow.copy()	Copy package into a new package of the same type.
NodePropertyFlow.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
NodePropertyFlow.get_regrid_methods()	Returns the default regrid methods for this package.
Recharge(*_, **__)	Recharge Package.
Recharge.from_imod5_data(imod5_data, ...[, ...])	Construct an rch-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
Recharge.from_imod5_cap_data(imod5_data, ...)	Construct an rch-package from iMOD5 data in the CAP package, loaded with the imod.formats.prj.open_projectfile_data() function.
Recharge.mask(mask)	Mask values outside of domain.
Recharge.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
Recharge.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
Recharge.write(pkgname, globaltimes, directory)	Write package to file
Recharge.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Recharge.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
Recharge.copy()	Copy package into a new package of the same type.
Recharge.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Recharge.get_regrid_methods()	Returns the default regrid methods for this package.
Recharge.aggregate_layers(dataset)	Aggregate data over layers into planar dataset.
Recharge.reallocate(dis[, npf, ...])	Reallocates topsystem data across layers and create new package with it.
River(*_, **__)	River package.
River.from_imod5_data(key, imod5_data, ...)	Construct a river-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
River.mask(mask)	Mask values outside of domain.
River.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
River.cleanup(dis)	Clean up package inplace.
River.clip_box([time_min, time_max, ...])	Clip a package by a bounding box (time, layer, y, x).
River.write(pkgname, globaltimes, directory)	Write package to file
River.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
River.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
River.copy()	Copy package into a new package of the same type.
River.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
River.get_regrid_methods()	Returns the default regrid methods for this package.
River.aggregate_layers(dataset)	Aggregate data over layers into planar dataset.
River.reallocate(dis[, npf, ...])	Reallocates topsystem data across layers and create new package with it.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.clip_box([...])	Clip a barrier by a bounding box (y, x).
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.write(...)	Write package to file
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.to_netcdf(*args)	Write dataset contents to a netCDF file.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.copy()	Copy package into a new package of the same type.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.get_regrid_methods()	Returns the default regrid methods for this package.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
SingleLayerHorizontalFlowBarrierMultiplier(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierMultiplier.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierMultiplier.clip_box([...])	Clip a barrier by a bounding box (y, x).
SingleLayerHorizontalFlowBarrierMultiplier.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
SingleLayerHorizontalFlowBarrierMultiplier.write(...)	Write package to file
SingleLayerHorizontalFlowBarrierMultiplier.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
SingleLayerHorizontalFlowBarrierMultiplier.to_netcdf(*args)	Write dataset contents to a netCDF file.
SingleLayerHorizontalFlowBarrierMultiplier.copy()	Copy package into a new package of the same type.
SingleLayerHorizontalFlowBarrierMultiplier.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
SingleLayerHorizontalFlowBarrierMultiplier.get_regrid_methods()	Returns the default regrid methods for this package.
SingleLayerHorizontalFlowBarrierMultiplier.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
SingleLayerHorizontalFlowBarrierMultiplier.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
SingleLayerHorizontalFlowBarrierResistance(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierResistance.cleanup(dis)	Cleanup the package inplace by removing barriers that fall outside of the active model domain.
SingleLayerHorizontalFlowBarrierResistance.from_imod5_data(...)
SingleLayerHorizontalFlowBarrierResistance.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierResistance.clip_box([...])	Clip a barrier by a bounding box (y, x).
SingleLayerHorizontalFlowBarrierResistance.snap_to_grid(dis)	Snap the barriers to the grid edges of the discretization.
SingleLayerHorizontalFlowBarrierResistance.write(...)	Write package to file
SingleLayerHorizontalFlowBarrierResistance.from_file(...)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
SingleLayerHorizontalFlowBarrierResistance.to_netcdf(*args)	Write dataset contents to a netCDF file.
SingleLayerHorizontalFlowBarrierResistance.copy()	Copy package into a new package of the same type.
SingleLayerHorizontalFlowBarrierResistance.is_empty([...])	Returns True if the package is empty, that is if it contains only no-data values.
SingleLayerHorizontalFlowBarrierResistance.get_regrid_methods()	Returns the default regrid methods for this package.
SingleLayerHorizontalFlowBarrierResistance.mask(_)	The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.
SingleLayerHorizontalFlowBarrierResistance.regrid_like(...)	Creates a package of the same type as this package, based on another discretization.
SpecificStorage(*_, **__)	Storage Package with specific storage.
SpecificStorage.mask(mask)	Mask values outside of domain.
SpecificStorage.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
SpecificStorage.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
SpecificStorage.write(pkgname, globaltimes, ...)	Write package to file
SpecificStorage.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
SpecificStorage.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
SpecificStorage.copy()	Copy package into a new package of the same type.
SpecificStorage.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
SpecificStorage.get_regrid_methods()	Returns the default regrid methods for this package.
StorageCoefficient(*_, **__)	Storage Package with a storage coefficient.
StorageCoefficient.from_imod5_data(...[, ...])	Construct a StorageCoefficient-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
StorageCoefficient.mask(mask)	Mask values outside of domain.
StorageCoefficient.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
StorageCoefficient.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
StorageCoefficient.write(pkgname, ...[, ...])	Write package to file
StorageCoefficient.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
StorageCoefficient.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
StorageCoefficient.copy()	Copy package into a new package of the same type.
StorageCoefficient.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
StorageCoefficient.get_regrid_methods()	Returns the default regrid methods for this package.
UnsaturatedZoneFlow(*_, **__)	Unsaturated Zone Flow (UZF) package.
UnsaturatedZoneFlow.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
UnsaturatedZoneFlow.mask(mask)	Mask values outside of domain.
UnsaturatedZoneFlow.regrid_like(target_grid, ...)	Creates a package of the same type as this package, based on another discretization.
UnsaturatedZoneFlow.write(pkgname, ...[, ...])	Write package to file
UnsaturatedZoneFlow.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
UnsaturatedZoneFlow.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
UnsaturatedZoneFlow.copy()	Copy package into a new package of the same type.
UnsaturatedZoneFlow.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
UnsaturatedZoneFlow.get_regrid_methods()	Returns the default regrid methods for this package.
Well(*_, **__)	Agnostic WEL package, which accepts x, y and a top and bottom of the well screens.
Well.cleanup(dis)	Clean up package inplace.
Well.from_imod5_data(key, imod5_data, times)	Convert wells to imod5 data, loaded with imod.formats.prj.open_projectfile_data(), to a Well object.
Well.mask(domain)	Mask wells based on two-dimensional domain.
Well.regrid_like(target_grid, regrid_cache)	Creates a package of the same type as this package, based on another discretization.
Well.to_mf6_pkg(active, top, bottom, k[, ...])	Write package to Modflow 6 package.
Well.clip_box([time_min, time_max, ...])	Clip a well package by a bounding box (time, layer, y, x).
Well.write(pkgname, globaltimes, directory)	Write package to file
Well.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Well.to_netcdf(*args[, mdal_compliant, crs])	Write dataset contents to a netCDF file.
Well.copy()	Copy package into a new package of the same type.
Well.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Well.get_regrid_methods()	Returns the default regrid methods for this package.

Transport Packages

AdvectionCentral(*_, **__)	The central-in-space weighting scheme is based on a simple distance-weighted linear interpolation between the center of cell n and the center of cell m to calculate solute concentration at the shared face between cell n and cell m.
AdvectionCentral.write(pkgname, globaltimes, ...)	Write package to file
AdvectionCentral.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
AdvectionCentral.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
AdvectionCentral.copy()	Copy package into a new package of the same type.
AdvectionCentral.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
AdvectionCentral.get_regrid_methods()	Returns the default regrid methods for this package.
AdvectionTVD(*_, **__)	An implicit second order TVD scheme.
AdvectionTVD.write(pkgname, globaltimes, ...)	Write package to file
AdvectionTVD.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
AdvectionTVD.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
AdvectionTVD.copy()	Copy package into a new package of the same type.
AdvectionTVD.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
AdvectionTVD.get_regrid_methods()	Returns the default regrid methods for this package.
AdvectionUpstream(*_, **__)	The upstream weighting (first order upwind) scheme sets the concentration at the cellface between two adjacent cells equal to the concentration in the cell where the flow comes from.
AdvectionUpstream.write(pkgname, ...[, ...])	Write package to file
AdvectionUpstream.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
AdvectionUpstream.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
AdvectionUpstream.copy()	Copy package into a new package of the same type.
AdvectionUpstream.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
AdvectionUpstream.get_regrid_methods()	Returns the default regrid methods for this package.
ConstantConcentration(*_, **__)	Constant Concentration package.
ConstantConcentration.write(pkgname, ...[, ...])	Write package to file
ConstantConcentration.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
ConstantConcentration.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
ConstantConcentration.copy()	Copy package into a new package of the same type.
ConstantConcentration.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
ConstantConcentration.get_regrid_methods()	Returns the default regrid methods for this package.
Dispersion(*_, **__)	Molecular Diffusion and Dispersion.
Dispersion.write(pkgname, globaltimes, directory)	Write package to file
Dispersion.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
Dispersion.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
Dispersion.copy()	Copy package into a new package of the same type.
Dispersion.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
Dispersion.get_regrid_methods()	Returns the default regrid methods for this package.
ImmobileStorageTransfer(*_, **__)	The Immobile Storage and Transfer (IST) package represents an immobile fraction of groundwater.
ImmobileStorageTransfer.write(pkgname, ...)	Write package to file
ImmobileStorageTransfer.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
ImmobileStorageTransfer.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
ImmobileStorageTransfer.copy()	Copy package into a new package of the same type.
ImmobileStorageTransfer.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
ImmobileStorageTransfer.get_regrid_methods()	Returns the default regrid methods for this package.
MobileStorageTransfer(*_, **__)	Mobile Storage.
MobileStorageTransfer.write(pkgname, ...[, ...])	Write package to file
MobileStorageTransfer.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
MobileStorageTransfer.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
MobileStorageTransfer.copy()	Copy package into a new package of the same type.
MobileStorageTransfer.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
MobileStorageTransfer.get_regrid_methods()	Returns the default regrid methods for this package.
MassSourceLoading(*_, **__)	Mass Source Loading (SRC) package for structured discretization (DIS) models.
MassSourceLoading.write(pkgname, ...[, ...])	Write package to file
MassSourceLoading.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
MassSourceLoading.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
MassSourceLoading.copy()	Copy package into a new package of the same type.
MassSourceLoading.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
MassSourceLoading.get_regrid_methods()	Returns the default regrid methods for this package.
SourceSinkMixing(*_, **__)
SourceSinkMixing.from_flow_model(model, species)	Derive a Source and Sink Mixing package from a Groundwater Flow model's boundary conditions (e.g. GeneralHeadBoundary).
SourceSinkMixing.write(pkgname, globaltimes, ...)	Write package to file
SourceSinkMixing.from_file(path, **kwargs)	Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).
SourceSinkMixing.to_netcdf(*args[, ...])	Write dataset contents to a netCDF file.
SourceSinkMixing.copy()	Copy package into a new package of the same type.
SourceSinkMixing.is_empty([ignore_time])	Returns True if the package is empty, that is if it contains only no-data values.
SourceSinkMixing.get_regrid_methods()	Returns the default regrid methods for this package.

Regrid

Regrid Method Settings

ConstantHeadRegridMethod([head, ...])	Object containing regridder methods for the imod.mf6.ConstantHead package.
DiscretizationRegridMethod([top, bottom, ...])	Object containing regridder methods for the imod.mf6.StructuredDiscretization and imod.mf6.VerticesDiscretization packages.
DispersionRegridMethod([...])	Object containing regridder methods for the imod.mf6.Dispersion package.
DrainageRegridMethod([elevation, ...])	Object containing regridder methods for the imod.mf6.Drainage package.
EmptyRegridMethod()
EvapotranspirationRegridMethod([surface, ...])	Object containing regridder methods for the imod.mf6.Evapotranspiration package.
GeneralHeadBoundaryRegridMethod([head, ...])	Object containing regridder methods for the imod.mf6.GeneralHeadBoundary package.
InitialConditionsRegridMethod([start])	Object containing regridder methods for the imod.mf6.InitialConditions package.
MobileStorageTransferRegridMethod([...])	Object containing regridder methods for the imod.mf6.MobileStorageTransfer package.
NodePropertyFlowRegridMethod([icelltype, k, ...])	Object containing regridder methods for the imod.mf6.NodePropertyFlow package.
RechargeRegridMethod([rate, concentration])	Object containing regridder methods for the imod.mf6.Recharge package.
RiverRegridMethod([stage, conductance, ...])	Object containing regridder methods for the imod.mf6.River package.
SpecificStorageRegridMethod([convertible, ...])	Object containing regridder methods for the imod.mf6.SpecificStorage package.
StorageCoefficientRegridMethod([...])	Object containing regridder methods for the imod.mf6.StorageCoefficient package.