Move to 2.0.0 RC 1

README.md

@@ -28,15 +28,34 @@ The `pyrealm` package currently includes:
   between carbon capture and water loss. This includes recent extensions to incorporate
   the effects of water stress, slow acclimation processes, models of C3/C4 competition
   and carbon isotope fractionation.
-* The T Model of the allocation of gross primary productivity to estimate net primary
-  productivity and hence plant growth.
 * The SPLASH model for calculating soil moisture and actual evapotranspiration.
+* Initial components of a demography module for modelling plant functional types,
+  cohorts, communities and canopies, including allocation calculations using the T
+  Model.
 * A suite of core physics functions and other utilities used to support the modules
   above.
 
 For more details, see the package website:
 [https://pyrealm.readthedocs.io/](https://pyrealm.readthedocs.io/).
 
+## Version 2.0.0 development
+
+New functionality being implemented after version 1.0.0 has lead to some immediate
+breaking changes in the API, for example in the handling of quantum yield settings in
+the class signatures for the `PModel` and `SubdailyPModel`. As the package uses
+[semantic versioning](https://semver.org/), these changes to the API require that new
+releases be made under a new major version.
+
+We will be publishing a series of "release candidates" of the 2.0.0 package. These will
+be used to identify issues with the current API and try to stabilise a new API. The
+content of version 2.0.0 is not yet finalised, so these release candidates may also add
+new functionality.
+
+We recommend that you update to the most recent release candidate of version 2.0.0. The
+documentation now includes a [migration
+guide](https://pyrealm.readthedocs.io/en/develop/users/versions.html) to help update
+existing code.
+
 ## Using `pyrealm`
 
 The `pyrealm` package requires Python 3 and the currently supported Python versions are:

docs/source/conf.py

@@ -219,7 +219,7 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
     "version_selector": True,
     "prev_next_buttons_location": "top",
     "style_external_links": False,
-    "style_nav_header_background": "white",
+    "style_nav_header_background": "grey",
     # Toc options
     "collapse_navigation": False,
     "sticky_navigation": True,

docs/source/index.md

@@ -58,6 +58,23 @@ The `demography` module
   and respiration {cite:p}`Li:2014bc`. This module is still in active development but a
   lot of initial functionality is present.
 
+## Version 2.0.0 development
+
+New functionality being implemented after version 1.0.0 has lead to some immediate
+breaking changes in the API, for example in the handling of quantum yield settings in
+the class signatures for the `PModel` and `SubdailyPModel`. As the package uses
+[semantic versioning](https://semver.org/), these changes to the API require that new
+releases be made under a new major version.
+
+We will be publishing a series of "release candidates" of the 2.0.0 package. These will
+be used to identify issues with the current API and try to stabilise a new API. The
+content of version 2.0.0 is not yet finalised, so these release candidates may also add
+new functionality.
+
+We recommend that you update to the most recent release candidate of version 2.0.0. The
+documentation now includes a [migration guide](users/versions.md) to help update
+existing code.
+
 ## Indices and tables
 
 * {ref}`genindex`

pyproject.toml

@@ -28,7 +28,7 @@ packages = [
 ]
 readme = "README.md"
 repository = "https://github.com/ImperialCollegeLondon/pyrealm"
-version = "1.0.0"
+version = "2.0.0-rc.1"
 
 [tool.poetry.dependencies]
 dacite = "^1.6.0"