unifhy.Model.from_yaml

classmethod Model.from_yaml(yaml_file)

Instantiate a Model from a YAML configuration file.

Parameters

yaml_file: str

A string providing the path to the YAML file to be used to instantiate Model.

Parameter example:

yaml_file='configurations/dummy.yml'

Examples

>>> m = Model.from_yaml('configurations/dummy_same_t_same_s.yml')
>>> print(m)
Model(
    identifier: test-dummy-same_t-same_s
    config directory: outputs
    saving directory: outputs
    surfacelayer: tests.components.surfacelayer.dummy
    subsurface: tests.components.subsurface.dummy
    openwater: tests.components.openwater.dummy
    nutrientsurfacelayer: tests.components.nutrientsurfacelayer.dummy
    nutrientsubsurface: tests.components.nutrientsubsurface.dummy
    nutrientopenwater: tests.components.nutrientopenwater.dummy
)