Skip to content

eWaterCycle/ewatercycle-leakybucket

Repository files navigation

eWaterCycle plugin example: a leaky bucket model

This repository is a template for adding models to eWatercycle, and will guide you through all required steps.

As an example this plugin adds the "leakybucket" model.

To use the template, press the green "Use this template" button on GitHub, and replace all instances of "leakybucket"/"LeakyBucket" with your model name.

Installation

Install this package alongside your eWaterCycle installation

pip install ewatercycle-leakybucket

Then LeakyBucket becomes available as one of the eWaterCycle models

from ewatercycle.models import LeakyBucket

Implementing your own model

For more information on how this plugin works, and on how to implement your own model see the plugin guide

License

ewatercycle-plugin is distributed under the terms of the Apache-2.0 license.