eWaterCycle / ewatercycle

Python package for running hydrological models
https://ewatercycle.readthedocs.io/en/latest/
Apache License 2.0
35 stars 5 forks source link

Make V2 Release #384

Closed Peter9192 closed 8 months ago

Peter9192 commented 1 year ago

Move plugins to their own repo

For each model:

Finally:

sverhoeven commented 1 year ago
  1. Make repo

At https://github.com/new?template_name=ewatercycle-leakybucket&template_owner=eWaterCycle

* set owner to eWaterCycle
* set name to ewatercycle-hype
  1. Remove plugin guide + demo notebook
git rm plugin_guide.md
git rm demo_containerized_model.ipynb 
  1. Search & replace (case sensitive)

    1. Hype -> Hype
    2. leakybucket -> hype
  2. Rename dir

git mv src/ewatercycle_leakybucket/ src/ewatercycle_hype
  1. Update description in pyproject.toml

  2. Copy files from core to plugin

cp ../ewatercycle/src/ewatercycle/plugins/hype/*py src/ewatercycle_hype/
cp -r ../ewatercycle/docs/plugins/hype docs
rm docs/index.rst
cp -r ../ewatercycle/tests/plugins/hype tests/

Commit with link to commit of version

https://github.com/eWaterCycle/ewatercycle/commit/ad99ebfbe9b83917ad079e7ee9e28bd761c79576
  1. Update readme

  2. Add forcing entry point to pyproject.toml

[project.entry-points."ewatercycle.forcings"]
HypeForcing = "ewatercycle_hype.forcing:HypeForcing"
  1. Put back version

In "src/ewatercycle_leakybucket/__init__.py"

__version__ = "0.1.0"

And remove version field from pyproject.toml

  1. Depend on ewatercycle>=2.0.0

Edit pyproject.toml

  1. Enable Zenodo integration

On https://zenodo.org/account/settings/github/ flip the switch for ewatercycle-hype

  1. Update imports in python files

Rename ewatercycle.plugins.hype to ewatercycle_hype

  1. Run tests locally
# mamba install
pip install ../ewatercycle
pip install -e .
pip install pytest
pytest
  1. Add CI

  2. RSD

Create entry

Invite maintainers Stefan,Bart,Peter

sverhoeven commented 1 year ago

https://github.com/eWaterCycle/ewatercycle-hype

sverhoeven commented 1 year ago

https://github.com/eWaterCycle/ewatercycle-lisflood

sverhoeven commented 1 year ago

https://github.com/eWaterCycle/ewatercycle-marrmot

sverhoeven commented 1 year ago

https://github.com/eWaterCycle/ewatercycle-pcrglobwb

Had to rename existing private repo

sverhoeven commented 1 year ago

https://github.com/eWaterCycle/ewatercycle-wflow

BSchilperoort commented 8 months ago

V2 was released successfully, including all model plugins.