ewatercycle.parameter_sets.default module

class ewatercycle.parameter_sets.default.ParameterSet(name: str, directory: str, config: str, doi='N/A', target_model='generic', supported_model_versions: Optional[Set[str]] = None)

Bases: object

Container object for parameter set options.

name

Name of parameter set

Type: str

directory

Location on disk where files of parameter set are stored. If Path is relative then relative to CFG[‘parameterset_dir’].

Type: Path

config

Model configuration file which uses files from directory. If Path is relative then relative to CFG[‘parameterset_dir’].

Type: Path

doi

Persistent identifier of parameter set. For a example a DOI for a Zenodo record.

Type: str

target_model

Name of model that parameter set can work with

Type: str

supported_model_versions

Set of model versions that are supported by this parameter set. If not set then parameter set will be supported by all versions of model

Type: Set[str]

property is_available: bool: Tests if directory and config file is available on this machine