smash.io.save_grid_parameters

smash.io.save_grid_parameters(model, path, parameters=None, save_active_cell=False)

Save the Model grid parameters (rainfall-runoff parameters and initial states) to GeoTIFF.

Grid parameters are saved to GeoTIFF format in a specified directory. Relevant metadata will be embedded within the GeoTIFF files. Additionally, the active cell mask can be saved as a separate GeoTIFF.

Parameters:

modelModel

Primary data structure of the hydrological model smash.

pathstr

Directory path where the GeoTIFF files will be saved. If the directory does not exist, it will be created.

parametersstr, list[str, …] or None, default None

Name of parameters grid to save. Should be one or a sequence of any key of:

• Model.rr_parameters

• Model.rr_initial_states

>>> parameters = "cp"
>>> parameters = ["cp", "ct", "kexc", "llr"]

Note

If not given, all parameters in Model.rr_parameters will be saved.

save_active_cellbool, default False

Whether or not to save the active cell mask.

See also

read_grid_parameters

Read the Model grid parameters (rainfall-runoff parameters and initial states) from GeoTIFF.

Examples

>>> from smash.factory import load_dataset
>>> from smash.io import save_grid_parameters
>>> setup, mesh = load_dataset("cance")
>>> model = smash.Model(setup, mesh)

Save all rr_parameters

>>> save_grid_parameters(model, "rr_parameters_dir")

Save only a subset of rr_parameters

>>> save_grid_parameters(model, "rr_parameters_dir", ["cp", "ct"])

Save all rr_parameters and rr_initial_states

>>> parameters = list(model.rr_parameters.keys) + list(model.rr_initial_states.keys)
>>> parameters
['ci', 'cp', 'ct', 'kexc', 'llr', 'hi', 'hp', 'ht', 'hlr']
>>> save_grid_parameters(model, "rr_parameters_initial_states_dir", parameters)

Save all rr_parameters and the active cell mask.

>>> save_grid_parameters(model, "rr_parameters_dir", save_active_cell=True)