API reference for litter modules

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

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

  • The litter_model submodule instantiates the LitterModel class which consolidates the functionality of the litter model into a single class, which the high level functions of the Virtual Ecosystem can then make use of.

  • The litter_pools provides the set of litter pools that the litter model is comprised of.

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