DHI / mikepluspy

MIKE+Py is the official python interface for MIKE+
Apache License 2.0
6 stars 1 forks source link

Update readme for 2024 experimental release. #12

Closed ryan-kipawa closed 5 months ago

ryan-kipawa commented 5 months ago

This PR prepares mikeplus-python for an experimental release for MIKE+ 2024. The package will still not be deployed to PyPI. Users wanting to test out the package will need to install from this repository.

Additionally, this PR proposes a versioning and branch strategy for mikeplus-python.

Versioning

The versioning is consistent with this standard. I propose that releases be made in step with MIKE+ releases as follows:

Branch strategy

Using a single main branch is problematic because of the different MIKE+ versions. We want to make it easy for people to contribute, as well as to fix minor bugs themselves in a particular version they're using. For this I propose:

If you have any other suggestions feel free to comment :)

I have already added some tags for v2024.0.0 and v2024.0-latest. It is back a few commits, since the latest main branch appears inconsistent with MIKE+ 2024 public release.

ecomodeller commented 5 months ago

❗ Don't forget to update this line https://github.com/DHI/mikeplus-python/blob/9cab8f3946a44bf2b0a96e4baa84c42d8ca2a5ad/pyproject.toml#L10