emod_api.demographics.PropertiesAndAttributes module

class emod_api.demographics.PropertiesAndAttributes.IndividualProperty(initial_distribution: Optional[List[float]] = None, property=None, values: Optional[List[float]] = None, transitions: Optional[List[float]] = None, transmission_matrix: Optional[List[float]] = None)[source]

Bases: emod_api.demographics.Updateable.Updateable

to_dict() dict[source]
class emod_api.demographics.PropertiesAndAttributes.IndividualProperties(individual_property: Optional[emod_api.demographics.PropertiesAndAttributes.IndividualProperty] = None)[source]

Bases: emod_api.demographics.Updateable.Updateable

add(individual_property)[source]
add_parameter(key, value)[source]

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

to_dict() 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: emod_api.demographics.Updateable.Updateable

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

Bases: emod_api.demographics.Updateable.Updateable

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

Bases: emod_api.demographics.Updateable.Updateable

to_dict() dict[source]
from_dict(age_distribution: dict)[source]
class FertilityDistribution(axis_names: Optional[List[str]] = None, axis_scale_factors: Optional[List[float]] = 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: emod_api.demographics.Updateable.Updateable

to_dict() dict[source]
from_dict(fertility_distribution: dict)[source]
class MortalityDistribution(axis_names: Optional[List[str]] = None, axis_scale_factors: Optional[List[float]] = 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: emod_api.demographics.Updateable.Updateable

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: Optional[int] = None, altitude=None, area: Optional[float] = None, birth_rate: Optional[float] = None, country=None, growth_rate: Optional[float] = None, name: Optional[str] = None, latitude: Optional[float] = None, longitude: Optional[float] = None, metadata: Optional[dict] = None, initial_population: Optional[int] = None, region: Optional[int] = None, seaport: Optional[int] = None, larval_habitat_multiplier: Optional[List[float]] = None, initial_vectors_per_species=None, infectivity_multiplier: Optional[float] = None, extra_attributes: Optional[dict] = None)[source]

Bases: emod_api.demographics.Updateable.Updateable

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