MODFLOW6

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).

Model objects & methods

Modflow6Simulation(name)
Modflow6Simulation.create_time_discretization(...)	Collect all unique times from model packages and additional given times.
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.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_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.
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.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.
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.

Discretization

StructuredDiscretization(*_, **__)	Discretization information for structered grids is specified using the file.
StructuredDiscretization.regrid_like(...[, ...])	Regrid discretization package.
StructuredDiscretization.from_imod5_data(...)	Construct package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.
StructuredDiscretization.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
VerticesDiscretization(*_, **__)	Discretization by Vertices (DISV).
VerticesDiscretization.regrid_like(...[, ...])	Creates a package of the same type as this package, based on another discretization.
VerticesDiscretization.clip_box([time_min, ...])	Clip a package by a bounding box (time, layer, y, x).
TimeDiscretization(*_, **__)	Timing for all models of the simulation is controlled by the Temporal Discretization (TDIS) 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.
Solution(*_, **__)	Iterative Model Solution.
SolutionPresetSimple(modelnames[, ...])
SolutionPresetModerate(modelnames[, ...])
SolutionPresetComplex(modelnames[, ...])

Flow Packages

ApiPackage(*_, **__)	The API package can be used to interact with the dll-version of Modflow (libMF6.dll).
Buoyancy(*_, **__)	Buoyancy package.
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).
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).
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).
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).
HorizontalFlowBarrierHydraulicCharacteristic(*_, ...)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierHydraulicCharacteristic.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierMultiplier(*_, **__)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierMultiplier.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierResistance(*_, **__)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierResistance.to_mf6_pkg(...)	Write package to Modflow 6 package.
HorizontalFlowBarrierResistance.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
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.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 package by a bounding box (time, layer, y, x).
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).
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).
Recharge(*_, **__)	Recharge Package.
Recharge.from_imod5_data(imod5_data, target_dis)	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).
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.split_conductance(conductance, ...)	Seperates (exfiltration) conductance with an infiltration factor (iMODFLOW) into a drainage conductance and a river conductance following methods explained in Zaadnoordijk (2009).
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierHydraulicCharacteristic.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
SingleLayerHorizontalFlowBarrierMultiplier(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierMultiplier.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierMultiplier.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
SingleLayerHorizontalFlowBarrierResistance(*_, ...)	Horizontal Flow Barrier (HFB) package
SingleLayerHorizontalFlowBarrierResistance.from_imod5_data(...)
SingleLayerHorizontalFlowBarrierResistance.to_mf6_pkg(...)	Write package to Modflow 6 package.
SingleLayerHorizontalFlowBarrierResistance.clip_box([...])	Clip a package by a bounding box (time, layer, y, x).
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).
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).
UnsaturatedZoneFlow(*_, **__)	Unsaturated Zone Flow (UZF) 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 package by a bounding box (time, layer, y, x).
WellDisStructured(*_, **__)	WEL package for structured discretization (DIS) models .
WellDisVertices(*_, **__)	WEL package for discretization by vertices (DISV) models.

Transport Packages

ApiPackage(*_, **__)	The API package can be used to interact with the dll-version of Modflow (libMF6.dll).
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.
AdvectionTVD(*_, **__)	An implicit second order TVD scheme.
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.
ConstantConcentration(*_, **__)	Constant Concentration package.
Dispersion(*_, **__)	Molecular Diffusion and Dispersion.
ImmobileStorageTransfer(*_, **__)	The Immobile Storage and Transfer (IST) package represents an immobile fraction of groundwater.
MobileStorageTransfer(*_, **__)	Mobile Storage.
MassSourceLoading(*_, **__)	Mass Source Loading (SRC) package for structured discretization (DIS) models.
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).

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.