Adding a model

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

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

  • Import model in src/ewatercycle/models/

  • Add src/ewatercycle/forcing/<model>.py

  • Register model in src/ewatercycle/forcing/

  • Add model to docs/

  • Write example notebook

  • Write tests?

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

  • Add example parameter set in src/ewatercycle/parameter_sets/

  • Add container image to System setup

  • Add container image to infrastructure data preparation scripts

We will expand this documentation in due time.

Adding a new version of a model

A model can have different versions. A model version in the eWaterCycle Python package corresponds to the tag of Docker image and the version in a Singularity container image filename. The version of the container image should preferably be one of release versions of the model code. Alternativly the version could be the name of a feature branch or a date.

Also parameter sets can be specify which versions of a model they support.

To add a new version of a model involves the following steps:

Create container image

  • Create Docker container image named ewatercycle/<model>-grpc4bmi:<version> with grpc4bmi server running as entrypoint

  • Host Docker container image on Docker Hub

  • Create Singularity image from Docker with singularity build ./ewatercycle-<model>-grpc4bmi_<version>.sif docker://ewatercycle/<model>-grpc4bmi:<version>

Add to Python package

  • Add container image to System setup page by editing docs/system_setup.rst

  • In src/ewatercycle/models/<model>.py

    • add new version to available_versions class property.

    • to __init__() method add support for new version

  • Optionally: Add new version to existing example parameter set or add new parameter set in src/ewatercycle/parameter_sets/_<model>.py:example_parameter_sets()

  • Add new version to supported parameter sets in local eWaterCycle config file (/etc/ewatercycle.yaml and ~/.config/ewatercycle/ewatercycle.yaml)

  • Test it out locally

  • Create pull request and get it merged

  • Create new release of Python package. Done by package maintainers

Add to platform

For platform developers and deployers.

  • Add Singularity image to dCache shared folder ewcdcache:/singularity-images/<model>-grpc4bmi_<version>.sif

  • Add container image to infrastructure repository

  • Install version/branch of eWaterCycle Python package with new model version on any running virtual machines

  • Optionally: Add example parameter set to explorer catalog. The forcing, parameter set and model image should be available on Jupyter server connected to explorer.