pycopancore.model_components.base.interface module

Base model component interface.

Specifies the variables used by this component, by entity type and process taxon

class Cell

Bases: object

Basic Cell interface.

It contains all variables specified as mandatory (“base variables”).

culture

reference to another entity or process taxon

environment

reference to another entity or process taxon

fossil_carbon = extensive variable 'fossil carbon stock' ((mass of C in any chemical compound,                              potentially accessible for human extraction                              and combustion)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

individuals

reference to a set of entities

land_area = variable 'land area', not None, scale=ratio, datatype=<class 'float'>, unit=square kilometers [km²], >0

location = variable 'location' (pair of coordinates?), scale=ratio, datatype=<class 'float'>

metabolism

reference to another entity or process taxon

social_system

reference to another entity or process taxon

social_systems

reference to a set of entities

terrestrial_carbon = extensive variable 'terrestrial carbon stock' ((mass of C in any chemical compound)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

world

reference to another entity or process taxon

class Culture

Bases: object

Basic Culture interface.

It contains all variables specified as mandatory (“base variables”).

acquaintance_network = variable 'acquaintance network' (Basic undirected social network of acquaintance between                  Individuals. Most other social networks will be subgraphs of this.), ref=https://en.wikipedia.org/wiki/Interpersonal_relationship#Stages, not None, scale=nominal, datatype=<class 'networkx.classes.graph.Graph'>

group_membership_network = variable 'group membership network' (Directed network from individual to group that                  signifies membership (to avoid problems due to n to n relation)), not None, scale=nominal, datatype=<class 'networkx.classes.digraph.DiGraph'>

groups

reference to a set of entities

individuals

reference to a set of entities

social_systems

reference to a set of entities

class Environment

Bases: object

Basic Environment interface.

It contains all variables specified as mandatory (“base variables”).

geographic_network = variable 'geographic network' (Undirected network of cells and geographic neighborhood.                  Two cells should be linked iff they share a common boundary of positive                  measure.), not None, scale=ratio, datatype=<class 'networkx.classes.graph.Graph'>

worlds

reference to a set of entities

class Group

Bases: object

Basic Group interface.

It contains all variables specified as mandatory (“base variables”).

culture

reference to another entity or process taxon

environment

reference to another entity or process taxon

group_members

reference to a set of entities

metabolism

reference to another entity or process taxon

class Individual

Bases: object

Basic Individual interface.

It contains all variables specified as mandatory (“base variables”).

acquaintances

reference to a set of entities

cell

reference to another entity or process taxon

culture

reference to another entity or process taxon

environment

reference to another entity or process taxon

group_memberships

reference to a set of entities

metabolism

reference to another entity or process taxon

population_share = None

relative_weight = variable 'relative representation weight' (relative representation weight for social_system's population, to be used in determining how many people this individual represents), not None, scale=ratio, datatype=<class 'float'>, unit=unity [], >=0

represented_population = read-only extensive variable 'represented population' (absolute population represented by this individual), scale=ratio, datatype=<class 'float'>, unit=people [H]

social_system

reference to another entity or process taxon

social_systems

reference to a set of entities

world

reference to another entity or process taxon

class Metabolism

Bases: object

Basic Metabolism interface.

It contains all variables specified as mandatory (“base variables”).

worlds

reference to a set of entities

class Model

Bases: object

Basic Model component interface.

description = 'Basic model component only providing basic relationships between entity types.'

name = 'copan:CORE Base'

requires = []

class SocialSystem

Bases: object

Basic SocialSystem interface.

It contains all variables specified as mandatory (“base variables”).

cells

reference to a set of entities

culture

reference to another entity or process taxon

direct_cells

reference to a set of entities

direct_individuals

reference to a set of entities

environment

reference to another entity or process taxon

higher_social_systems

reference to a set of entities

individuals

reference to a set of entities

lower_social_systems

reference to a set of entities

metabolism

reference to another entity or process taxon

next_higher_social_system

reference to another entity or process taxon

next_lower_social_systems

reference to a set of entities

population = extensive variable 'human population', IAMC=Population, CETS=SP.POP, not None, scale=ratio, datatype=<class 'float'>, unit=people [H], >=0

world

reference to another entity or process taxon

class World

Bases: object

Basic World interface.

It contains all variables specified as mandatory (“base variables”).

acquaintance_network = None

atmospheric_carbon = extensive variable 'atmospheric carbon stock' ((mass of C in any chemical compound)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

cells

reference to a set of entities

culture

reference to another entity or process taxon

environment

reference to another entity or process taxon

fossil_carbon = extensive variable 'fossil carbon stock' ((mass of C in any chemical compound,                              potentially accessible for human extraction                              and combustion)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

group_membership_network = None

groups

reference to a set of entities

individuals

reference to a set of entities

metabolism

reference to another entity or process taxon

ocean_carbon = extensive variable 'ocean carbon stock' ((mass of C in any chemical compound)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

population = extensive variable 'human population', IAMC=Population, CETS=SP.POP, not None, scale=ratio, datatype=<class 'float'>, unit=people [H], >=0

social_systems

reference to a set of entities

surface_air_temperature = intensive variable 'surface air temperature' ((in the meaning used in climate policy debates,                  i.e., at 2m above surface, averaged over the day)), AMIP=tas, not None, scale=ratio, datatype=<class 'float'>, unit=kelvins [K], >=0

terrestrial_carbon = extensive variable 'terrestrial carbon stock' ((mass of C in any chemical compound)), not None, scale=ratio, datatype=<class 'float'>, unit=gigatonnes carbon [GtC], >=0

top_level_social_systems

reference to a set of entities