Skip to content

malaria_vector_species_params

species_params(manifest, species=None)

Returns configured species parameters based on species name.

Prefer VectorSpeciesParameters and its from_preset() classmethod for new code.

Parameters:

Name Type Description Default
manifest object

module containing schema_file path

 required
species str

name of the species to configure

 None

Returns:

Type Description
object | list[str]

Schema-backed parameters dict if species is found;
object | list[str]

list of available species names otherwise.
Source code in emodpy_malaria/malaria_vector_species_params.py 
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
def species_params(manifest: object, species: str = None) -> object | list[str]:
    """
    Returns configured species parameters based on species name.

    Prefer [VectorSpeciesParameters](https://emod.idmod.org/emodpy-malaria/autoapi/emodpy_malaria/vector_config/)
    and its `from_preset()` classmethod for new code.

    Args:
        manifest (object): module containing ``schema_file`` path
        species (str): name of the species to configure

    Returns:
        Schema-backed parameters dict if species is found;
        list of available species names otherwise.
    """
    if species not in _SPECIES_DATA:
        return BUILTIN_SPECIES

    preset = copy.deepcopy(_SPECIES_DATA[species])
    from emod_api import campaign as api_campaign
    if not api_campaign.get_schema():
        api_campaign.set_schema(manifest.schema_file)
    preset._campaign = api_campaign
    for h in preset.habitats:
        h._campaign = api_campaign
    return preset.to_schema_dict()