Adding a model

Integrating a new model into the eWaterCycle system involves the following steps:

  • Create model as subclass of AbstractModel (ewatercycle/models/

  • Import model in ewatercycle/models/

  • Add ewatercycle/forcing/<model>.py

  • Register model in ewatercycle/forcing/

  • Add model to docs/

  • Write example notebook

  • Write tests?

  • If model needs custom parameter set class add it in ewatercycle/parameter_sets/_<model name>.py

  • Add example parameter set in ewatercycle/parameter_sets/

  • Add container image to setup guide

We will expand this documentation in due time.