ewatercycle.models.wflow module

eWaterCycle wrapper around WFlow BMI.

class ewatercycle.models.wflow.Wflow(version: str, parameter_set: ParameterSet, forcing: Optional[WflowForcing] = None)

Bases: AbstractModel[WflowForcing]

Create an instance of the Wflow model class.

Parameters

  • version – pick a version from available_versions

  • parameter_set – instance of ParameterSet.

  • forcing – instance of WflowForcing or None. If None, it is assumed that forcing is included with the parameter_set.

available_versions: ClassVar[Tuple[str, ...]] = ('2020.1.1', '2020.1.2', '2020.1.3')

Show supported WFlow versions in eWaterCycle

setup(cfg_dir: Optional[str] = None, **kwargs) → Tuple[str, str]

Start the model inside a container and return a valid config file.

Parameters

  • cfg_dir – a run directory given by user or created for user.

  • **kwargs (optional, dict) – see parameters for all configurable model parameters.

Returns

Path to config file and working directory

get_value_as_xarray(name: str) → xarray.DataArray

Return the value as xarray object.

property parameters: Iterable[Tuple[str, Any]]

List the configurable parameters for this model.

forcing: Optional[ForcingT]
bmi: Bmi

Basic Modeling Interface object