API reference for animals modules

The animals module is one of the component models of the Virtual Ecosystem. It is comprised of a number of submodules.

Each of the animal sub-modules has its own API reference page:

• The animal_model submodule instantiates the AnimalModel class which consolidates the functionality of the animal module into a single class, which the high level functions of the Virtual Ecosystem can then make use of.

• The animal_communities provides a class for containing and managing all of the animal cohorts within a grid square.

• The animal_cohorts provides a class for the individual animal cohorts, their attributes, and behaviors.

• The functional_group provides a class for the animal functional groups that define the type of animal in an animal cohort.

• The animal_traits provides classes for the traits that feed into the functional group class definitions.

• The scaling_functions provides a set of allometric scaling functions that define the biological rates used in the animal module.

• The constants provides a set of dataclasses containing the constants required by the broader animal model.

• The decay provides a model for both surface carcasses created by mortality and animal excrement.

• The plant_resources provides the PlantResources class, which provides an API for exposing plant model data via the animal model protocols.