ewatercycle.parameter_sets
Module to manage parameter sets.
Module Contents
- ewatercycle.parameter_sets.logger
- ewatercycle.parameter_sets.add_to_config(parameter_set: ewatercycle.base.parameter_set.ParameterSet)
Add a parameter set to the e:py:data:ewatercycle.config.CFG object.
- Parameters:
parameter_set – Parameter set to add to the config.
- ewatercycle.parameter_sets.available_parameter_sets(target_model: str | None = None) dict[str, ewatercycle.base.parameter_set.ParameterSet]
List available parameter sets on this machine.
- Parameters:
target_model – Filter parameter sets on a model name
- Returns:
Dictionary available parameter sets on current machine.
- ewatercycle.parameter_sets.example_parameter_sets() dict[str, ewatercycle.base.parameter_set.ParameterSet]
Lists the available example parameter sets.
They can be downloaded with
download_example_parameter_sets()
.To get your own example parameter set to be listed here it needs to be registered in the
ewatercycle.parameter_sets
entry point group.
- ewatercycle.parameter_sets.download_example_parameter_sets(skip_existing=True)
Downloads all of the example parameter sets and adds them to the config_file.
Downloads to parameterset_dir directory defined in
ewatercycle.config.CFG
.- Parameters:
skip_existing – When true will not download any parameter set which already has a local directory. When false will raise ValueError exception when parameter set already exists.