Release 0.12 (#285)

* Update HISTORY
* Bump version: 0.11.0 → 0.12.0

---------

Co-authored-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>

.cruft.json

@@ -10,7 +10,7 @@
       "project_slug": "ravenpy",
       "project_short_description": "A Python wrapper to setup and run the hydrologic modelling framework Raven.",
       "pypi_username": "CSHS-CWRA",
-      "version": "0.11.0",
+      "version": "0.12.0",
       "use_pytest": "y",
       "use_black": "y",
       "use_pypi_deployment_with_travis": "y",

.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
       - id: python-check-blanket-noqa
       - id: rst-inline-touching-normal
   - repo: https://github.com/pappasam/toml-sort
-    rev: v0.23.0
+    rev: v0.23.1
     hooks:
       - id: toml-sort-fix
   - repo: https://github.com/psf/black

HISTORY.rst

@@ -4,12 +4,22 @@ History
 
 0.12.0 (2023-05-25)
 -------------------
+This release includes major breaking changes. It completely overhauls how models are defined, and how to run
+simulations, and any code relying on the previous release will most likely break. Please check the documentation
+to see how to use the new improved interface.
 
-* Ravenpy now employs a new method for installing the Raven model using the `raven-hydro <https://github.com/Ouranosinc/raven-hydro>`_ python package  (based on `scikit-build-core`).
-* Replaced `setup.py`, `requirements.txt`, and `Manifest.in` for `PEP 517 <https://peps.python.org/pep-0517>`_ compliance (`pyproject.toml`) using the flit backend.
+Breaking changes
+^^^^^^^^^^^^^^^^
+* The entire model configuration and simulation interface (see PR #269).
+* The Raven model executable is now updated to v3.7.
+* Added support for Ensemble Kalman Filter using RavenC.
+* Now employing the `spotpy` package for model calibration instead of `ostrich`.
+* BasinMaker importer assumes `SubBasin=HRU` in order to work with files downloaded from the BasinMaker web site.
+* Ravenpy now employs a new method for installing the Raven model using the `raven-hydro <https://github.com/Ouranosinc/raven-hydro>`_ python package  (based on `scikit-build-core`) (see PR #278).
+* Replaced `setup.py`, `requirements.txt`, and `Manifest.in` for `PEP 517 <https://peps.python.org/pep-0517>`_ compliance (`pyproject.toml`) using the flit backend (see PR #278).
 * Dealt with an import-based error that occurred due to the sequence in which modules are loaded at import (attempting to call ravenpy before it is installed).
 * Updated pre-commit hooks to include formatters and checkers for TOML files.
-* The build recipes no longer build on each other, so when installing the dev or docs recipe, you must also install the gis recipe.
+* The build recipes no longer build on each other, so when installing the `dev` or `docs` recipe, you must also install the gis recipe.
 * Updated the GeoServer API calls to work with the GeoPandas v0.13.0.
 
 0.11.0 (2023-02-16)

README.rst

@@ -15,7 +15,7 @@ Raven_ is an hydrological modeling framework that lets hydrologists build hydrol
 
 `RavenPy` provides a Python interface to Raven_, automating the creation of configuration files and allowing the model to be launched from Python. Results, or errors, are automatically parsed and exposed within the programming environment. This facilitates the launch of parallel simulations, multi-model prediction ensembles, sensitivity analyses and other experiments involving a large number of model runs.
 
-Note that version 0.20.0 includes many major changes compared to the previous 0.12 release, and breaks backward compatibility, notably, the Raven model is now compiled/installed/managed via a dedicated pip/conda package `raven-hydro`_. The other benefits of these changes are a much more intuitive interface for configuring and running the model.
+Note that version 0.12 includes major changes compared to the previous 0.11 release, and breaks backward compatibility. The benefits of these changes are a much more intuitive interface for configuring and running the model.
 
 Features
 --------

ravenpy/__version__.py

@@ -4,4 +4,4 @@
 
 __author__ = "David Huard"
 __email__ = "huard.david@ouranos.ca"
-__version__ = "0.11.0"
+__version__ = "0.12.0"

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.11.0
+current_version = 0.12.0
 commit = True
 tag = False