ewatercycle.models.lisflood module

eWaterCycle wrapper around Lisflood BMI.

class ewatercycle.models.lisflood.Lisflood(version: str, parameter_set: ewatercycle.parameter_sets.default.ParameterSet, forcing: ewatercycle.forcing._lisflood.LisfloodForcing)

Bases: ewatercycle.models.abstract.AbstractModel[ewatercycle.forcing._lisflood.LisfloodForcing]

eWaterCycle implementation of Lisflood hydrological model.

Parameters

version – pick a version for which an grpc4bmi docker image is available.
parameter_set – LISFLOOD input files. Any included forcing data will be ignored.
forcing – a LisfloodForcing object.

Example

See examples/lisflood.ipynb in ewatercycle repository

available_versions: ClassVar[Tuple[str, ...]] = ('20.10',): Versions for which ewatercycle grpc4bmi docker images are available.

setup(IrrigationEfficiency: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, MaskMap: Optional[str] = None, cfg_dir: Optional[str] = None) → Tuple[str, str]

Configure model run.

Creates config file and config directory based on the forcing variables and time range.
Start bmi container and store as bmi

Parameters

IrrigationEfficiency – Field application irrigation efficiency. max 1, ~0.90 drip irrigation, ~0.75 sprinkling
start_time – Start time of model in UTC and ISO format string e.g. ‘YYYY-MM-DDTHH:MM:SSZ’. If not given then forcing start time is used.
end_time – End time of model in UTC and ISO format string e.g. ‘YYYY-MM-DDTHH:MM:SSZ’. If not given then forcing end time is used.
MaskMap – Mask map to use instead of one supplied in parameter set. Path to a NetCDF or pcraster file with same dimensions as parameter set map files and a boolean variable.
cfg_dir – a run directory given by user or created for user.

Returns

Path to config file and path to config directory

get_value_as_xarray(name: str) → xarray.DataArray: Return the value as xarray object.

property parameters: Iterable[Tuple[str, Any]]: List the parameters for this model.