pyrealm
packageThe pyrealm
package provides a toolbox implementing some key models for estimating
plant productivity, growth and demography in Python. The outputs of different models
can be then easily fed into other models within pyrealm
to allow productivity
estimates to be fed forward into estimation of net primary productivity, growth and
ultimately plant community demography.
The pyrealm
package currently includes:
For more details, see the package website: https://pyrealm.readthedocs.io/.
pyrealm
The pyrealm
package requires Python 3 and the currently supported Python versions are:
3.10, 3.11 and 3.12. We make released package versions available via
PyPi and also generate DOIs for each release via
Zenodo. You can install the most recent
release using pip
:
pip install pyrealm
You can now get started using pyrealm
. For example, to calculate the estimated gross
primary productivity of a C3 plant in a location, start a Python interpreter, using
python
, python3
or ipython
depending on your installation, and run:
import numpy as np
from pyrealm.pmodel import PModelEnvironment, PModel
# Calculate the photosynthetic environment given the conditions
env = PModelEnvironment(
tc=np.array([20]), vpd=np.array([1000]),
co2=np.array([400]), patm=np.array([101325.0])
)
# Calculate the predictions of the P Model for a C3 plant
pmodel_c3 = PModel(env)
# Estimate the GPP from the model given the absorbed photosynthetically active light
pmodel_c3.estimate_productivity(fapar=1, ppfd=300)
# Report the GPP in micrograms of carbon per m2 per second.
pmodel_c3.gpp
This should give the following output:
array([76.42544948])
The package website provides worked examples of using pyrealm
, for example to:
These worked examples also show how pyrealm
can be used within Python scripts or
Jupyter notebooks and how to use pyrealm
with large datasets loaded using
numpy
or xarray
with
pyrealm
classes and functions.
pyrealm
The pyrealm
repository can be cited following the information in the citation
file. If you are using pyrealm
in research, it is better to cite the
DOI of the specific release from Zenodo.
pyrealm
If you are interested in contributing to the development of pyrealm
, please read the
guide for contributors. Please do also read the code of
conduct for contributing to this project.
Development of the prealm
package has been supported by the following grants and
institutions: