API for the decay module

The decay module contains pools which are still potentially forageable by animals but are in the process of microbial decomposition. And the moment this consists of animal carcasses and excrement.

Classes:

CarcassPool(scavengeable_energy, ...)

This class store information about the carcass biomass in each grid cell.

ExcrementPool(scavengeable_energy, ...)

This class store information about the amount of excrement in each grid cell.

class virtual_ecosystem.models.animals.decay.CarcassPool(scavengeable_energy: float, decomposed_energy: float)

This class store information about the carcass biomass in each grid cell.

Methods:

decomposed_carbon(grid_cell_area)

Calculate carbon stored in decomposed carcasses based on the energy.

Attributes:

decomposed_energy

The amount of decomposed energy in the carcass pool [J].

scavengeable_energy

The amount of animal accessible energy in the carcass pool [J].

decomposed_carbon(grid_cell_area: float) float

Calculate carbon stored in decomposed carcasses based on the energy.

TODO - At the moment this literally just assumes that a kilogram of carbon contains 10^6 J, in future this needs to be properly parametrised.

Parameters:

grid_cell_area – The size of the grid cell [m^2]

Returns:

The amount of decomposed carcass biomass in carbon terms [kg C m^-2]

decomposed_energy: float

The amount of decomposed energy in the carcass pool [J].

scavengeable_energy: float

The amount of animal accessible energy in the carcass pool [J].

class virtual_ecosystem.models.animals.decay.ExcrementPool(scavengeable_energy: float, decomposed_energy: float)

This class store information about the amount of excrement in each grid cell.

Methods:

decomposed_carbon(grid_cell_area)

Calculate carbon stored in decomposed excrement based on the energy.

Attributes:

decomposed_energy

The amount of decomposed energy in the excrement pool [J].

scavengeable_energy

The amount of animal accessible energy in the excrement pool [J].

decomposed_carbon(grid_cell_area: float) float

Calculate carbon stored in decomposed excrement based on the energy.

TODO - At the moment this literally just assumes that a kilogram of carbon contains 10^6 J, in future this needs to be properly parametrised.

Parameters:

grid_cell_area – The size of the grid cell [m^2]

Returns:

The amount of decomposed excrement in carbon terms [kg C m^-2]

decomposed_energy: float

The amount of decomposed energy in the excrement pool [J].

scavengeable_energy: float

The amount of animal accessible energy in the excrement pool [J].