Skip to content

mosquitorelease

add_scheduled_mosquito_release(campaign, start_day=0, node_ids=None, repetitions=1, timesteps_between_repetitions=365, intervention_name=iv_name, released_number=None, released_ratio=None, released_infectious=None, released_species='arabiensis', released_genome=None, released_mate_genome=None, released_microsporidia=None) 

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:

Name Type Description Default
campaign EMODCampaign

A campaign builder that also contains schema_path parameters

 required
start_day int

The day to release the vectors.

 0
node_ids list

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

 None
repetitions int

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

 1
timesteps_between_repetitions int

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

 365
intervention_name str

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.

 iv_name
released_number int

The number of mosquitoes to release, this parameter sets Released_Type = "FIXED_NUMBER" automatically.

 None
released_ratio float

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.

 None
released_infectious float

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'

 None
released_species str

The case-sensitive name of the species of vectors to be released.

 'arabiensis'
released_genome list[list[str]]

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.

 None
released_mate_genome list[list[str]]

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.

 None
released_microsporidia any

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

 None
Source code in emodpy_malaria/interventions/mosquitorelease.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def add_scheduled_mosquito_release(
        campaign,
        start_day: int = 0,
        node_ids: list = None,
        repetitions: int = 1,
        timesteps_between_repetitions: int = 365,
        intervention_name: str = iv_name,
        released_number: int = None,
        released_ratio: float = None,
        released_infectious: float = None,
        released_species: str = "arabiensis",
        released_genome: list[list[str]] = None,
        released_mate_genome: list[list[str]] = None,
        released_microsporidia: any = None):
    """
        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.

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): 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.
    """

    node_intervention = _mosquito_release(campaign=campaign,
                                          intervention_name=intervention_name,
                                          released_number=released_number,
                                          released_ratio=released_ratio,
                                          released_infectious=released_infectious,
                                          released_species=released_species,
                                          released_genome=released_genome,
                                          released_mate_genome=released_mate_genome,
                                          released_microsporidia=released_microsporidia)
    add_campaign_event(campaign=campaign,
                       start_day=start_day,
                       node_ids=node_ids,
                       repetitions=repetitions,
                       timesteps_between_repetitions=timesteps_between_repetitions,
                       node_intervention=node_intervention)

new_intervention_as_file(campaign, start_day=1, filename='MosquitoRelease.json') 

Creates a campaign file with a MosquitoRelease intervention

Parameters:

Name Type Description Default
campaign EMODCampaign

A campaign builder that also contains schema_path parameters

 required
start_day int

The day to release the vectors.

 1
filename str

name of campaign filename to be created

 'MosquitoRelease.json'

Returns:

Type Description
str

returns filename
Source code in emodpy_malaria/interventions/mosquitorelease.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def new_intervention_as_file(campaign, start_day: int = 1, filename: str = "MosquitoRelease.json"):
    """
        Creates a campaign file with a MosquitoRelease intervention

    Args:
        campaign (emodpy.campaign.emod_campaign.EMODCampaign): 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:
        (str): returns filename
    """
    add_scheduled_mosquito_release(campaign=campaign, start_day=start_day, released_number=1)
    campaign.save(filename)
    return filename