index.md

jupytext	kernelspec
formats text_representation md:myst extension format_name .md myst	display_name language name Python 3 python python3

The pyrealm package

Module overview

The package contains a number of different modules implementing different models:

1. The P Model: a ecophysiological model of carbon dioxide uptake by plants (:{cite}Prentice:2014bc, :{cite}Wang:2017go, :{cite}Stocker:2020dh)
2. TODO

Package documentation

The documentation for pyrealm is maintained using sphinx. The module code is documented using Google style docstrings in RST format. Much of the rest of the documentation uses Jupyter notebooks written using myst-nb format in order to dynamically include Python code examples showing the behaviour of functions. In general, the code will be concealed but the underlying code can be seen by clicking on the buttons like the one below.

:tags: [hide-input]
# This is just an example code cell to demonstrate how code is included in 
# the pyrealm documentation.

Development notes

.. toctree::
  :maxdepth: 4
  :caption: The P Model
  :hidden:

  pmodel/pmodel.md
  pmodel/rpmodel.md
  pmodel/optimal_chi.md
  pmodel/lue_vcmax.md
  pmodel/pmodel_reference.md

.. toctree::
  :maxdepth: 4
  :caption: The T Model
  :hidden:
  
  tmodel/tmodel.md
  tmodel/tmodel_reference.md

.. toctree::
  :maxdepth: 4
  :caption: Additional detail
  :hidden:
  
  params.md
  z_bibliography.rst

.. automodule:: pyrealm.version
    :members:

Indices and tables

• {ref}genindex
• {ref}modindex
• {ref}search