xarray.Dataset.climepi.run_epi_model#
- Dataset.climepi.run_epi_model(epi_model, **kwargs)#
Run the epidemiological model on a climate dataset.
- Parameters:
epi_model (
climepi.epimod.EpiModel) – The epidemiological model to run.**kwargs (
dict, optional) – Keyword arguments to pass to the model’s run method. For suitability models, passing “return_months_suitable=True” will return the number of months suitable each year, rather than the full suitability dataset, and additionally passing a value for “suitability_threshold” will set the minimum suitability threshold for a month to be considered suitable (default is 0).
- Returns:
xarray.Dataset– The output of the model’s run method.