Merge pull request #120 from EcoExtreML/release0.5

prepare for release 0.5

Author: SarahAlidoost

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.5.0
 
 [bumpversion:file:PyStemmusScope/__init__.py]
 search = __version__ = "{current_version}"

CITATION.cff

@@ -18,9 +18,19 @@ authors:
     family-names: Liu
     given-names: Yang
     orcid: "https://orcid.org/0000-0002-1966-8460"
-date-released: 2022-11-24
+  -
+    affiliation: "Univesrity of Twente"
+    family-names: Daoud
+    given-names: Mostafa Gomaa
+    orcid: "https://orcid.org/0000-0001-5112-1708"
+  -
+    affiliation: "Univesrity of Twente"
+    family-names: Zeng
+    given-names: Yijian
+    orcid: "https://orcid.org/0000-0002-2166-5314"
+date-released: 2025-01-14
 doi: <insert your DOI here>
-version: "0.4.0"
+version: "0.5.0"
 repository-code: "https://github.com/EcoExtreML/stemmus_scope_processing"
 keywords:
   - STEMMUS SCOPE Processing

PyStemmusScope/__init__.py

@@ -9,4 +9,4 @@
 
 __author__ = "Sarah Alidoost"
 __email__ = "[email protected]"
-__version__ = "0.4.0"
+__version__ = "0.5.0"

docs/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2025-01-14
+
+### Added:
+
+- Ground water coupling in BMI in
+  [#101](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/101)
+- A notebook to demonstrate how to run the model coupling with stemmus_scope and
+  modflow in
+  [#101](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/101)
+- Optional key `soil_layers_thickness` to the config in
+  [#104](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/104)
+- Optional key `SleepDuration` to the config and bmi implementation in
+  [#116](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/116)
+- GitHib action to create a docker container in [#118](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/118)
+
+### Changed:
+
+- BMI variables in [#116](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/116)
+- Dockerfile in [#117](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/117)
+- `MCR_CACHE_ROOT` added to the `local_process.py` in [#117](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/117) to fix MATLAB RunTime error, see [#110](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/issues/110)
+- Documentation is updated in [#117](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/pull/117)
+
+
 ## [0.4.0] - 2024-02-08
 
 ### Added:
@@ -67,3 +90,4 @@ The first release of PyStemmusScope. Compatible with STEMMUS_SCOPE 1.1.11.
 [0.2.1]: https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/releases/tag/v0.2.1
 [0.3.0]: https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/releases/tag/v0.3.0
 [0.4.0]: https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/releases/tag/v0.4.0
+[0.5.0]: https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/releases/tag/v0.5.0

pull_request_template.md

@@ -13,7 +13,5 @@ Please add a description of the changes proposed in the pull request.
 - [ ] Add tests.
 - [ ] Add changes to the [changelog file](./docs/CHANGELOG.md) under section `Unreleased`.
 - [ ] If your changes are about BMI, make sure that your changes are compatible
-  with [the latest version of
-  STEMMUS_SCOPE](https://github.com/EcoExtreML/STEMMUS_SCOPE/releases) and [its
-  of docker
-  image](https://github.com/orgs/EcoExtreML/packages?repo_name=STEMMUS_SCOPE).
+  with [the latest version of STEMMUS_SCOPE](https://github.com/EcoExtreML/STEMMUS_SCOPE/releases)
+  and [its docker image](https://github.com/orgs/EcoExtreML/packages?repo_name=STEMMUS_SCOPE).