pycopancore.model_components.seven_dwarfs.interface module

model component Interface template.

TODO: adjust or fill in code and documentation wherever marked by “TODO:”, then remove these instructions.

class Cell[source]

Bases: object

Interface for Cell entity type mixin.

eating_stock = variable 'eating stock' (the eating stock), not None, scale=ratio, datatype=<class 'float'>, unit=kilograms [kg], >=0
class Culture[source]

Bases: object

Interface for Culture mixin

class Group[source]

Bases: object

Interface for Group mixin

having_members = variable 'test' (test), not None, scale=ratio, datatype=<class 'float'>
class Individual[source]

Bases: object

Interface for Individual entity type mixin.

age = variable 'age' (dwarf's age), not None, scale=ratio, datatype=<class 'float'>, unit=years [yr]
beard_growth_parameter = variable 'beard growth parameter' (growth speed of dwarf beard), not None, scale=ratio, datatype=<class 'float'>
beard_length = variable 'beard length' (length of beard), not None, scale=ratio, datatype=<class 'float'>, unit=meters [m]
eating_parameter = variable 'eating parameter' (eating speed of dwarf), not None, scale=ratio, datatype=<class 'float'>
class Model[source]

Bases: object

Interface for Model mixin.

description = '...'

some longer description

name = '...'

a unique name for the model component

requires = []

list of other model components required for this model component to make sense

class SocialSystem[source]

Bases: object

Interface for SocialSystem mixin

class World[source]

Bases: object

Interface for World mixin.