smash.io.read_model#

smash.io.read_model(path)[source]#

Read Model object from HDF5.

Parameters:

pathstr: The file path.

Returns:

modelModel: A Model object loaded from HDF5.

Raises:

FileNotFoundError:: If file not found.
ReadHDF5MethodError:: If file not created with save_model.

See also

save_model: Save Model object to HDF5.
smash.Model: Primary data structure of the hydrological model smash.

Examples

>>> from smash.factory import load_dataset
>>> from smash.io import save_model, read_model
>>> setup, mesh = load_dataset("cance")
>>> model = smash.Model(setup, mesh)
>>> model
Model
    atmos_data: ['mean_pet', 'mean_prcp', '...', 'sparse_prcp', 'sparse_snow']
    mesh: ['active_cell', 'area', '...', 'xres', 'ymax']
    ...
    setup: ['adjust_interception', 'compute_mean_atmos', '...', 'structure', 'temp_directory']
    u_response_data: ['q_stdev']
>>> model.setup.hydrological_module, model.setup.routing_module
('gr4', 'lr')

Save Model to HDF5

>>> save_model(model, "model.hdf5")

Read Model from HDF5

>>> model_rld = read_model("model.hdf5")
>>> model_rld
Model
    atmos_data: ['mean_pet', 'mean_prcp', '...', 'sparse_prcp', 'sparse_snow']
    mesh: ['active_cell', 'area', '...', 'xres', 'ymax']
    ...
    setup: ['adjust_interception', 'compute_mean_atmos', '...', 'structure', 'temp_directory']
    u_response_data: ['q_stdev']
>>> model.setup.hydrological_module, model.setup.routing_module
('gr4', 'lr')