emod_api.demographics.PropertiesAndAttributes module#

class emod_api.demographics.PropertiesAndAttributes.IndividualProperty(property: str, values: List[float] | List[str], initial_distribution: List[float] | None = None, transitions: List[dict] | None = None, transmission_matrix: List[List[float]] | None = None, transmission_route: str = 'Contact')[source]#

Bases: Updateable

to_dict() → dict[source]#
classmethod from_dict(ip_dict: dict) → __class__[source]#
class emod_api.demographics.PropertiesAndAttributes.IndividualProperties(individual_property: IndividualProperty | None = None)[source]#

Bases: Updateable

exception DuplicateIndividualPropertyException[source]#

Bases: Exception

exception NoSuchIndividualPropertyException[source]#

Bases: Exception

add(individual_property: IndividualProperty, overwrite=False) → None[source]#
add_parameter(key, value)[source]#

Adds a user defined key-value pair to demographics. :param key: Key :param value: Value :return: None

property ip_by_name#
has_individual_property(property_key: str) → bool[source]#
get_individual_property(property_key: str) → IndividualProperty[source]#
remove_individual_property(property_key: str)[source]#
to_dict() → List[dict][source]#
class emod_api.demographics.PropertiesAndAttributes.IndividualAttributes(age_distribution_flag: int = None, age_distribution1: int = None, age_distribution2: int = None, age_distribution: [<class 'emod_api.demographics.age_distribution.AgeDistribution'>, <class 'emod_api.demographics.age_distribution_old.AgeDistributionOld'>] = None, susceptibility_distribution_flag: int = None, susceptibility_distribution1: int = None, susceptibility_distribution2: int = None, susceptibility_distribution: ~emod_api.demographics.susceptibility_distribution.SusceptibilityDistribution | ~emod_api.demographics.susceptibility_distribution_old.SusceptibilityDistributionOld = None, prevalence_distribution_flag: int = None, prevalence_distribution1: int = None, prevalence_distribution2: int = None, risk_distribution_flag: int = None, risk_distribution1: int = None, risk_distribution2: int = None, migration_heterogeneity_distribution_flag: int = None, migration_heterogeneity_distribution1: int = None, migration_heterogeneity_distribution2: int = None, fertility_distribution: ~emod_api.demographics.fertility_distribution.FertilityDistribution | ~emod_api.demographics.fertility_distribution_old.FertilityDistributionOld = None, mortality_distribution: ~emod_api.demographics.mortality_distribution_old.MortalityDistributionOld = None, mortality_distribution_male: ~emod_api.demographics.mortality_distribution.MortalityDistribution | ~emod_api.demographics.mortality_distribution_old.MortalityDistributionOld = None, mortality_distribution_female: ~emod_api.demographics.mortality_distribution.MortalityDistribution | ~emod_api.demographics.mortality_distribution_old.MortalityDistributionOld = None, innate_immune_distribution_flag: int = None, innate_immune_distribution1: int = None, innate_immune_distribution2: int = None)[source]#

Bases: Updateable

property mortality_male_distribution#
property mortality_female_distribution#
to_dict() → dict[source]#
from_dict(individual_attributes: dict)[source]#
class emod_api.demographics.PropertiesAndAttributes.NodeAttributes(airport: int | None = None, altitude=None, area: float | None = None, birth_rate: float | None = None, country=None, growth_rate: float | None = None, name: str | None = None, latitude: float | None = None, longitude: float | None = None, metadata: dict | None = None, initial_population: int | None = None, region: int | None = None, seaport: int | None = None, larval_habitat_multiplier: List[float] | None = None, initial_vectors_per_species=None, infectivity_multiplier: float | None = None, extra_attributes: dict | None = None)[source]#

Bases: Updateable

from_dict(node_attributes: dict)[source]#
to_dict() → dict[source]#