diff --git a/README.md b/README.md index c75f42eb..38293b6e 100644 --- a/README.md +++ b/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: diff --git a/docs/source/_static/images/pyrealm_logo_master.svg b/docs/source/_static/images/pyrealm_logo_master.svg index 7aff24ce..925c738d 100644 --- a/docs/source/_static/images/pyrealm_logo_master.svg +++ b/docs/source/_static/images/pyrealm_logo_master.svg @@ -7,8 +7,11 @@ viewBox="0 0 210 297" version="1.1" id="svg5" - sodipodi:docname="pyrealm_logo.svg" + sodipodi:docname="pyrealm_logo_master.svg" inkscape:version="1.1.2 (b8e25be8, 2022-02-05)" + inkscape:export-filename="/Users/dorme/Research/REALM/pyrealm/docs/source/_static/images/pyrealm_logo_white_background.png" + inkscape:export-xdpi="300" + inkscape:export-ydpi="300" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -33,9 +36,25 @@ inkscape:window-x="47" inkscape:window-y="0" inkscape:window-maximized="0" - inkscape:current-layer="layer2" /> + inkscape:current-layer="layer4" /> + + + -