climepi.epimod.SuitabilityModel.run#
- SuitabilityModel.run(ds_clim, return_months_suitable=False, suitability_threshold=0)#
Run the epidemiological model on a given climate dataset.
Extends the parent method to include the option to return the number of months suitable each year, rather than the full suitability dataset.
- Parameters:
ds_clim (
xarray.Dataset) – The input climate dataset.return_months_suitable (
bool, optional) – Whether to return the number of months suitable each year, rather than the full suitability dataset. Default is False.suitability_threshold (
float, optional) – The minimum suitability threshold for a month to be considered suitable. Only used if return_months_suitable is True. Default is 0.
- Returns:
xarray.Dataset– The output epidemiological dataset.