API reference

Accessor class for xarray datasets

The climepi accessor class for xarray Dataset objects can be used by chaining the climepi attribute to a Dataset (e.g., ds.climepi.sel_geo('London'); see Accessor class for xarray datasets).

Classes

climepi.ClimEpiDatasetAccessor(dataset)

Accessor for xarray.Dataset objects accessed via the climepi attribute.

Methods

Dataset.climepi.ensemble_stats([data_var, ...])	Compute a range of ensemble statistics for a data variable.
Dataset.climepi.monthly_average([data_var])	Compute the monthly mean of a data variable.
Dataset.climepi.plot_map([data_var, ...])	Generate a map plot of a data variable.
Dataset.climepi.plot_time_series([data_var])	Generate a time series plot of a data variable.
Dataset.climepi.plot_uncertainty_interval_decomposition([...])	Plot contributions of climate uncertainty sources to uncertainty intervals.
Dataset.climepi.plot_variance_decomposition([...])	Plot decomposition of variance from different climate uncertainty sources.
Dataset.climepi.run_epi_model(epi_model, ...)	Run the epidemiological model on a climate dataset.
Dataset.climepi.sel_geo(location[, lon, lat])	Get data for the nearest grid point(s) to a specified location(s).
Dataset.climepi.temporal_group_average([...])	Compute the group average of a data variable.
Dataset.climepi.uncertainty_interval_decomposition([...])	Decompose uncertainty interval contributions.
Dataset.climepi.variance_decomposition([...])	Decompose variance contributions from different climate uncertainty sources.
Dataset.climepi.yearly_average([data_var])	Compute the yearly mean of a data variable.
Dataset.climepi.yearly_portion_suitable([...])	Calculate the portion of each year that is suitable given suitability data.

Climate data subpackage

Methods for downloading and accessing climate projection data are contained in the climdata subpackage (accessible via from climepi import climdata; see Climate data subpackage).

Methods

climdata.get_climate_data(data_source[, ...])	Retrieve climate projection data.
climdata.get_climate_data_file_names(data_source)	Retrieve file names of formatted climate data files.
climdata.get_example_dataset(name[, ...])	Retrieve an example climate dataset.

Epidemiological model subpackage

Classes and methods for climate-sensitive epidemiological models are contained in the epimod subpackage (accessible via from climepi import epimod; see Epidemiological model subpackage).

Classes

epimod.EpiModel()	Base class for epidemiological models.
epimod.SuitabilityModel([temperature_range, ...])	Generic class for suitability models.
epimod.ParameterizedSuitabilityModel(*, ...)	Class for parameterized suitability models.

Methods

epimod.get_example_model(name)	Get an example climate-sensitive epidemiological model.
epimod.get_example_temperature_response_data(name)	Get example temperature response data.
epimod.fit_temperature_response(*, ...[, ...])	Fit the dependence of a parameter on temperature.
epimod.get_posterior_temperature_response(...)	Get the posterior distribution of the fitted temperature response.

Front-end application subpackage

A method to run the front-end application is contained in the app subpackage (accessible via from climepi import app; see Front-end application).

Methods

app.run_app([clim_dataset_example_base_dir, ...])

Run the climepi front-end application locally.