API reference for plants modules

The plants module provides the PlantsModel implementation for use in the Virtual Ecosystem.

The main submodule is plants_model submodule, which provides the PlantsModel class as the main API to initialise and update the plants model.

The other submodules include:

• The model_config submodule provides configuration options for the model along with constants used in the model.

• The functional_types submodule implements the handling of individual plant functional types and the overall flora definition to be used in a simulation.

• The communities submodule provides the PlantCommunities class which maps each grid cell on to a representation of the plant community within that cell. Each grid cell has a single pyrealm.demography.community.Community object that contains includes a pyrealm.demography.community.Cohorts instance describing the size-structured cohorts of different plant functional types within the grid cell.

• The canopy submodule provides code to calculate the complete canopy structure across all cohorts for the plant community present in a particular grid cell.