xwrf.tutorial.open_dataset¶
- xwrf.tutorial.open_dataset(name, cache=True, cache_dir=None, *, engine='netcdf4', **kws)[source]¶
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:
"dummy"
"dummy_attrs_only"
"dummy_salem_parsed"
"polar_stereographic_1"
"polar_stereographic_2"
"lambert_conformal"
"mercator"
"met_em_sample"
"wrfout"
"ideal"
- Parameters:
name (str) – Name of the dataset. e.g. ‘mercator’
cache (bool, optional) – If True, then cache data locally for use on subsequent calls
cache_dir (path-like, optional) – The directory in which to search for and write cached data.
engine (str, optional) – Name of the backend engine to use.
**kws (dict, optional) – Additional keyword arguments passed through to the
open_dataset()
function.
- Returns:
The dataset.
- Return type: