API for the protocols module

The models.animals.protocols module contains a class provides eatability definition used by AnimalCohorts, PlantResources, and Carcasses in the animals module.

Classes:

Consumer(*args, **kwargs)	This is the protocol for defining consumers (currently just AnimalCohort).
DecayPool(*args, **kwargs)	Defines biotic pools containing both accessible and inaccessible energy.
Pool(*args, **kwargs)	This is a protocol for defining dummy abiotic pools containing energy.
Resource(*args, **kwargs)	This is the protocol for defining what classes work as trophic resources.

class virtual_ecosystem.models.animals.protocols.Consumer(*args, **kwargs)

This is the protocol for defining consumers (currently just AnimalCohort).

class virtual_ecosystem.models.animals.protocols.DecayPool(*args, **kwargs)

Defines biotic pools containing both accessible and inaccessible energy.

class virtual_ecosystem.models.animals.protocols.Pool(*args, **kwargs)

This is a protocol for defining dummy abiotic pools containing energy.

class virtual_ecosystem.models.animals.protocols.Resource(*args, **kwargs)

This is the protocol for defining what classes work as trophic resources.

Methods:

get_eaten(consumed_mass, consumer, pool)

The get_eaten method defines a resource.

get_eaten(consumed_mass: float, consumer: Consumer, pool: DecayPool) → float

The get_eaten method defines a resource.