emod_api.demographics.DemographicsTemplates module

emod_api.demographics.DemographicsTemplates.set_suscept_complex(config)

emod_api.demographics.DemographicsTemplates.set_suscept_simple(config)

emod_api.demographics.DemographicsTemplates.set_age_simple(config)

emod_api.demographics.DemographicsTemplates.set_age_complex(config)

emod_api.demographics.DemographicsTemplates.set_init_prev(config)

emod_api.demographics.DemographicsTemplates.set_boxcar_seasonal(config)

emod_api.demographics.DemographicsTemplates.NoRisk()

NoRisk puts everyone at 0 risk.

emod_api.demographics.DemographicsTemplates.FullRisk(demog)

FullRisk puts everyone at 100% risk.

emod_api.demographics.DemographicsTemplates.InitRiskUniform(demog, min=0, max=1)

InitRiskUniform puts everyone at somewhere between 0% risk and 100% risk, drawn uniformly.

Parameters

• min (float) – Low end of uniform distribution. Must be >=0, <1.

• max (float) – High end of uniform distribution. Must be >=min, <=1.

Returns

json object aka python dict that can be directly passed to Demographics::SetDefaultFromTemplate

Raises

None –

emod_api.demographics.DemographicsTemplates.NoInitialPrevalence(demog)

NoInitialPrevalence disables initial prevalence; outbreak seeding must be done from an Outbreak intervention (or serialized population).

Parameters

demog – emod-api.demographics.Demographics instance.

Returns

None

Raises

None –

emod_api.demographics.DemographicsTemplates.InitPrevUniform(demog, prevalence)

emod_api.demographics.DemographicsTemplates.InitSusceptConstant(demog)

emod_api.demographics.DemographicsTemplates.EveryoneInitiallySusceptible(demog, setting=1.0)

emod_api.demographics.DemographicsTemplates.StepFunctionSusceptibility(demog, protected_setting=0.0, threshold_age=1825.0)

emod_api.demographics.DemographicsTemplates.SimpleSusceptibilityDistribution(demog, meanAgeAtInfection=2.5)

emod_api.demographics.DemographicsTemplates.DefaultSusceptibilityDistribution(demog)

emod_api.demographics.DemographicsTemplates.MortalityRateByAge(AgeBins, MortRate)

Mortality Rate by Age

emod_api.demographics.DemographicsTemplates.ConstantMortality(CrudeMortRate)

emod_api.demographics.DemographicsTemplates.MortalityStructureNigeriaDHS()

emod_api.demographics.DemographicsTemplates.InitAgeUniform(demog)

emod_api.demographics.DemographicsTemplates.AgeStructureUNWPP(demog)

emod_api.demographics.DemographicsTemplates.EquilibriumAgeDistFromBirthAndMortRates(demog, CrudeBirthRate=0.04, CrudeMortRate=0.02)

emod_api.demographics.DemographicsTemplates.AddSeasonalForcing(demog, start=100, end=330, factor=1.0)

enable seasonal forcing on the default node attributes via boxcar scaling

Requires config enables infectivity scaling: e.g.: ‘Enable_Infectivity_Scaling’: 1, ‘Enable_Infectivity_Scaling_Boxcar’: 1,

emod_api.demographics.DemographicsTemplates.NoMigrationHeterogeneity()