easyclimate.core.tutorial

Tutorials in the easyclimate documentation

Functions

open_tutorial_dataset(→ xarray.Dataset)

Open a dataset from the online repository (requires internet).

Module Contents

easyclimate.core.tutorial.open_tutorial_dataset(name: str, cache: bool = True, cache_dir: None | str | os.PathLike = None, progressbar: bool = False, *, engine: xarray.backends.api.T_Engine = None, **kws) → xarray.Dataset

Open a dataset from the online repository (requires internet).

If a local copy is found then always use that to avoid network traffic.

Available datasets:

  • "air_202201_mon_mean": 2m air temperature of the NCEP reanalysis subset

  • "hgt_202201_mon_mean": Geopotential height of the NCEP reanalysis subset

  • "precip_202201_mon_mean": Precipitation of the NCEP reanalysis subset

  • "pressfc_202201_mon_mean": Mean sea surface pressure of the NCEP reanalysis subset

  • "shum_202201_mon_mean": Absolute humidity of the NCEP reanalysis subset

  • "uwnd_202201_mon_mean": Zonal wind of the NCEP reanalysis subset

  • "vwnd_202201_mon_mean": Meridional wind of the NCEP reanalysis subset

  • "omega_202201_mon_mean": Vertical velocity of the NCEP reanalysis subset

  • "mini_HadISST_ice": Hadley Centre Sea Ice and Sea Surface Temperature data set (HadISST) subset

  • "PressQFF_202007271200_872": Observational data from European stations (from https://github.com/EXCITED-CO2/xarray-regrid)

  • "pr_wtr_eatm_2022": Precipitable water of the NCEP reanalysis subset in the 2022

  • "sst_mnmean_oisst": NOAA Optimum Interpolation (OI) SST V2 (from https://psl.noaa.gov/data/gridded/data.noaa.oisst.v2.html)

Parameters

namestr

Name of the file containing the dataset. e.g. ‘air_202201_mon_mean’

cache_dirpath-like, optional

The directory in which to search for and write cached data.

cachedim: bool, optional

If True, then cache data locally for use on subsequent calls

progressbar: bool, default False.

If True, will print a progress bar of the download to standard error (stderr).

**kwsdict, optional

Passed to xarray.open_dataset

Returns

xarray.Dataset

Reference

  • Kalnay et al.,The NCEP/NCAR 40-year reanalysis project, Bull. Amer. Meteor. Soc., 77, 437-470, 1996

  • Rayner, N. A.; Parker, D. E.; Horton, E. B.; Folland, C. K.; Alexander, L. V.; Rowell, D. P.; Kent, E. C.; Kaplan, A. (2003) Global analyses of sea surface temperature, sea ice, and night marine air temperature since the late nineteenth century J. Geophys. Res.Vol. 108, No. D14, 4407 10.1029/2002JD002670 (pdf ~9Mb)

See also