climepi.epimod.get_example_model

climepi.epimod.get_example_model(name)

Get an example climate-sensitive epidemiological model.

Returns a climepi.epimod.EpiModel object for the example model specified by the name argument.

Parameters:

name (str) – The name of the example model to return. Currently available examples are: “kaye_ae_aegypti” (the temperature and rainfall suitability model for Ae. aegypti from https://doi.org/10.1101/2023.08.31.23294902), “mordecai_ae_aegypti” (the temperature suitability model for Ae. aegypti from https://doi.org/10.1371/journal.pntd.0005568), and “mordecai_ae_albopictus” (the temperature suitability model for Ae. albopictus from https://doi.org/10.1371/journal.pntd.0005568).

Returns:

epi_model (climepi.epimod.EpiModel) – An instance of the EpiModel class representing the example model.