emodpy_measles.interventions.measles_vaccine module#

emodpy_measles.interventions.measles_vaccine.SimpleMCV1(camp, timestep, coverage=1.0, nodes=None)[source]#

Create ‘type 1’ vaccine intervention campaign event at a specified time with a specified coverage in the specified nodes. Vaccine is distributed to infants 270 days after birth.

Parameters:

  • timestep – When? Timestep to distribute vaccine on.

  • coverage – Who? The percentage of the population in the nodes who should receive the vaccine. Defaults to everyone if omitted.

  • nodes – Where? The list of node ids where the vaccine should be distribution. Defaults to all if omitted.

Returns:

campaign event.

emodpy_measles.interventions.measles_vaccine.SimpleMCV2(camp, timestep, coverage=1.0, nodes=None)[source]#

Create ‘type 2’ vaccine intervention campaign event at a specified time with a specified coverage in the specified nodes. Vaccine is distributed to infants 475 days after birth.

Parameters:

  • timestep – When? Timestep to distribute vaccine on.

  • coverage – Who? The percentage of the population in the nodes who should receive the vaccine. Defaults to everyone if omitted.

  • nodes – Where? The list of node ids where the vaccine should be distribution. Defaults to all if omitted.

Returns:

campaign event.

emodpy_measles.interventions.measles_vaccine.SingleDoseRI(camp, RI_MCV1, dose_dist=None, nodes=None, waning=1.0, start_day=0, take_by_age_ages=None, take_by_age_values=None)[source]#

Single dose measles vaccine with a dosing delay distribution and take by age.

Parameters:

  • camp (emod_api.campaign) – The campaign instance

  • RI_MCV1 (float) – Demographic coverage of routine immunization in the range [0,1]

  • dose_dist (dict, optional) – Dose delay distribution. Defaults to {'Delay_Period_Distribution': "GAUSSIAN_DISTRIBUTION", 'Delay_Period_Gaussian_Mean': 300.0, 'Delay_Period_Gaussian_Std_Dev': 90.0})

  • nodes (list, optional) – Node ids where the vaccine should be distribution. Defaults to all.

  • waning (float, optional) – Constant rate of dose efficacy (See WaningEffectConstant). Defaults to 1.0.

  • start_day (int, optional) – Day to start the campaign. Defaults to 0.

  • take_by_age_ages (list, optional) – List of ages in years for the vaccines take-by-age.

  • take_by_age_values (list, optional) – List of take values for the vaccines take-by-age. Default is 0.85 < 9mo and 0.95 after.

Returns:

A emod_api.schema_to_class.ReadOnlyDict intervention

emodpy_measles.interventions.measles_vaccine.new_intervention_as_file(camp, timestep, filename=None)[source]#

Create a new ‘campaign.json’-type file with a single campaign event containing a Measles Vaccine intervention. This is mostly a test or didactic capability.

Parameters:

  • timestep – When? Timestep to distribute vaccine on.

  • filename – The name of the file to write to disk. Defaults to “measles_vaccine.json”.

Returns:

string with filename of newly created file.