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_ratio: float | None = None, released_infectious: float | None = None, released_species: str = 'arabiensis', released_genome: list[list[str]] | None = None, released_mate_genome: list[list[str]] | None = None, released_microsporidia: any | None = None)[source]#

Adds a node-targeted MosquitoRelease class intervention to the campaign. The MosquitoRelease intervention class adds mosquito release vector control programs to the simulation. Mosquito release is a key vector control mechanism that allows the release of sterile males, genetically modified mosquitoes, or even Microsporidia-infected mosquitoes.

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 mosquitoes to release, this parameter sets Released_Type = “FIXED_NUMBER” automatically.

  • released_ratio – The number of released mosquitoes is proportional to the mosquito population from the previous timestep, specifically considering mosquitoes of the same gender as those being released. This approach is used when on Released_Type is set to RATIO. This parameter sets Released_Type = “RATIO” automatically.

  • 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. Default is [[“X”, “X”]]. This only works for vectors that have no genes defined.

  • released_mate_genome – This defines the alleles of the mate genome of the vectors to be released. The Released_Mate_Genome must be male, and Released_Genome must be female. It must define all of the alleles including the gender ‘gene’. ‘*’ is not allowed. When this parameter is defined, the released female vectors will be fully gestated and ready to lay eggs, which will be the product of Released_Genome and Released_Mate_Genome.

  • 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