climepi.epimod.get_example_model

climepi.epimod.get_example_model(name)

Get an example climate-sensitive epidemiological model.

Returns a SuitabilityModel object for the example model specified by the name argument.

Parameters:

name (str) – The name of the example model to return. A list of available example names can be accessed as climepi.epimod.EXAMPLE_NAMES, and a description of each example can be accessed via the climepi.epimod.EXAMPLES dictionary (e.g., climepi.epimod.EXAMPLES['mordecai_ae_aegypti_niche']['doc']).

Returns:

epi_model (climepi.epimod.SuitabilityModel) – The example model.