emod_api.demographics.PropertiesAndAttributes module#

class emod_api.demographics.PropertiesAndAttributes.IndividualProperty(property: str, initial_distribution: List[float] | None = None, values: List[str] | None = None, transitions: List[float] | None = None, transmission_matrix: List[float] | None = None)[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=None, age_distribution1=None, age_distribution2=None, age_distribution=None, prevalence_distribution_flag=None, prevalence_distribution1=None, prevalence_distribution2=None, immunity_distribution_flag=None, immunity_distribution1=None, immunity_distribution2=None, risk_distribution_flag=None, risk_distribution1=None, risk_distribution2=None, migration_heterogeneity_distribution_flag=None, migration_heterogeneity_distribution1=None, migration_heterogeneity_distribution2=None, fertility_distribution=None, mortality_distribution=None, mortality_distribution_male=None, mortality_distribution_female=None, susceptibility_distribution=None)[source]#

Bases: Updateable

class SusceptibilityDistribution(distribution_values: List[float] | None = None, result_scale_factor=None, result_values=None)[source]#

Bases: Updateable

to_dict() → dict[source]#
class AgeDistribution(distribution_values=None, result_scale_factor=None, result_values=None)[source]#

Bases: Updateable

property num_dist_axes#
to_dict() → dict[source]#
from_dict(age_distribution: dict)[source]#
class FertilityDistribution(axis_names: List[str] | None = None, axis_scale_factors: List[float] | None = None, axis_units=None, num_distribution_axes=None, num_population_axes=None, num_population_groups=None, population_groups=None, result_scale_factor=None, result_units=None, result_values=None)[source]#

Bases: Updateable

property num_distribution_axes#
property num_population_axes#
property num_population_groups#
to_dict() → dict[source]#
from_dict(fertility_distribution: dict)[source]#
class MortalityDistribution(axis_names: List[str] | None = None, axis_scale_factors: List[float] | None = None, axis_units=None, num_distribution_axes=None, num_population_axes=None, num_population_groups=None, population_groups=None, result_scale_factor=None, result_units=None, result_values=None)[source]#

Bases: Updateable

property num_distribution_axes#
property num_population_axes#
property num_population_groups#
to_dict() → dict[source]#
from_dict(mortality_distribution: dict)[source]#
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]#