imod.mf6.Modflow6Simulation.open_transport_budget#
- Modflow6Simulation.open_transport_budget(species_ls: list[str] | None = None, simulation_start_time: datetime64 | None = None, time_unit: str | None = 'd') DataArray | UgridDataArray | Dataset | UgridDataset [source]#
Open transport budgets of finished simulation, requires that the
run
method has been called.The data is lazily read per timestep and automatically converted into (dense) xr.DataArrays or xu.UgridDataArrays, for DIS and DISV respectively. The conversion is done via the information stored in the Binary Grid file (GRB).
- Parameters:
species_ls (list of strings, default value: None.) – List of species names, which will be used to concatenate the concentrations along the
"species"
dimension, in case the simulation has multiple species and thus multiple transport models. If None, transport model names will be used as species names.- Returns:
budget – DataArray contains float64 data of the budgets, with dimensions (“time”, “layer”, “y”, “x”).
- Return type:
Dict[str, xr.DataArray|xu.UgridDataArray]