@@ -38,6 +38,9 @@ def _construct_cache_dir(path):
38
38
}
39
39
file_formats = {
40
40
"air_temperature" : 3 ,
41
+ "air_temperature_gradient" : 4 ,
42
+ "basin_mask" : 4 ,
43
+ "ersstv5" : 4 ,
41
44
"rasm" : 3 ,
42
45
"ROMS_example" : 4 ,
43
46
"tiny" : 3 ,
@@ -88,11 +91,14 @@ def open_dataset(
88
91
Available datasets:
89
92
90
93
* ``"air_temperature"``: NCEP reanalysis subset
94
+ * ``"air_temperature_gradient"``: NCEP reanalysis subset with approximate x,y gradients
95
+ * ``"basin_mask"``: Dataset with ocean basins marked using integers
91
96
* ``"rasm"``: Output of the Regional Arctic System Model (RASM)
92
97
* ``"ROMS_example"``: Regional Ocean Model System (ROMS) output
93
98
* ``"tiny"``: small synthetic dataset with a 1D data variable
94
99
* ``"era5-2mt-2019-03-uk.grib"``: ERA5 temperature data over the UK
95
100
* ``"eraint_uvz"``: data from ERA-Interim reanalysis, monthly averages of upper level data
101
+ * ``"ersstv5"``: NOAA's Extended Reconstructed Sea Surface Temperature monthly averages
96
102
97
103
Parameters
98
104
----------
@@ -108,7 +114,9 @@ def open_dataset(
108
114
109
115
See Also
110
116
--------
111
- xarray.open_dataset
117
+ tutorial.load_dataset
118
+ open_dataset
119
+ load_dataset
112
120
"""
113
121
try :
114
122
import pooch
@@ -218,9 +226,37 @@ def load_dataset(*args, **kwargs):
218
226
Open, load into memory, and close a dataset from the online repository
219
227
(requires internet).
220
228
229
+ If a local copy is found then always use that to avoid network traffic.
230
+
231
+ Available datasets:
232
+
233
+ * ``"air_temperature"``: NCEP reanalysis subset
234
+ * ``"air_temperature_gradient"``: NCEP reanalysis subset with approximate x,y gradients
235
+ * ``"basin_mask"``: Dataset with ocean basins marked using integers
236
+ * ``"rasm"``: Output of the Regional Arctic System Model (RASM)
237
+ * ``"ROMS_example"``: Regional Ocean Model System (ROMS) output
238
+ * ``"tiny"``: small synthetic dataset with a 1D data variable
239
+ * ``"era5-2mt-2019-03-uk.grib"``: ERA5 temperature data over the UK
240
+ * ``"eraint_uvz"``: data from ERA-Interim reanalysis, monthly averages of upper level data
241
+ * ``"ersstv5"``: NOAA's Extended Reconstructed Sea Surface Temperature monthly averages
242
+
243
+ Parameters
244
+ ----------
245
+ name : str
246
+ Name of the file containing the dataset.
247
+ e.g. 'air_temperature'
248
+ cache_dir : path-like, optional
249
+ The directory in which to search for and write cached data.
250
+ cache : bool, optional
251
+ If True, then cache data locally for use on subsequent calls
252
+ **kws : dict, optional
253
+ Passed to xarray.open_dataset
254
+
221
255
See Also
222
256
--------
257
+ tutorial.open_dataset
223
258
open_dataset
259
+ load_dataset
224
260
"""
225
261
with open_dataset (* args , ** kwargs ) as ds :
226
262
return ds .load ()
0 commit comments