emodpy_malaria.interventions.mosquitorelease module

emodpy_malaria.interventions.mosquitorelease.add_scheduled_mosquito_release(campaign, start_day: int = 0, node_ids: list | None = None, repetitions: int = 1, timesteps_between_repetitions: int = 365, intervention_name: str = 'MosquitoRelease', released_number: int | None = None, released_fraction: float | None = None, released_infectious: float | None = None, released_species: str = 'arabiensis', released_genome: list | None = None, released_microsporidia: any | None = None)[source]

Adds to the campaign a node-level MosquitoRelease intervention

Parameters:

  • campaign – A campaign builder that also contains schema_path parameters

  • start_day – The day to release the vectors.

  • node_ids – List of nodes to which to distribute the intervention. [] or None, indicates all nodes will get the intervention

  • repetitions – The number of times an intervention is given, used with timesteps_between_repetitions. -1 means the intervention repeats forever. Sets Number_Repetitions

  • timesteps_between_repetitions – The interval, in timesteps, between repetitions. Ignored if repetitions = 1. Sets Timesteps_Between_Repetitions

  • intervention_name – The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. It’s possible to have multiple MosquitoRelease interventions if they have different Intervention_Name values.

  • released_number – The number of vectors to release, sets Released_Type = “FIXED_NUMBER”

  • released_fraction – The fraction of the current population of mosquitoes to release. The ‘population’ will depend on the gender of the mosquitoes being released and it will be the population from the previous time step. Sets Released_Type = “FRACTION”

  • released_infectious – The fraction of vectors released that are to be infectious. One can only use this feature when ‘Malaria_Model’!=’MALARIA_MECHANISTIC_MODEL_WITH_PARASITE_GENETICS’

  • released_species – The case sensitive name of the species of vectors to be released.

  • released_genome – This defines the alleles of the genome of the vectors to be released. It must define all of the alleles including the gender ‘gene’. ‘*’ is not allowed.

  • released_microsporidia – The Strain_Name from the Microsporidia list defined for this species. Each species has its own strains. Empty String means no microsporidia.

Returns:

Formatted intervention

emodpy_malaria.interventions.mosquitorelease.new_intervention_as_file(campaign, start_day: int = 1, filename: str = 'MosquitoRelease.json')[source]

Creates a campaign file with a MosquitoRelease intervention

Parameters:

  • campaign – A campaign builder that also contains schema_path parameters

  • start_day – The day to release the vectors.

  • filename – name of campaign filename to be created

Returns:

returns filename