Open, load into memory (as a `DataTree`), and close a dataset from the online repository (requires internet). If a local copy is found then always use that to avoid network traffic. Available datasets: * ``"imerghh_730"``: GPM IMERG Final Precipitation L3 Half Hourly 0.1 degr
(*args, **kwargs)
| 347 | |
| 348 | |
| 349 | def load_datatree(*args, **kwargs) -> DataTree: |
| 350 | """ |
| 351 | Open, load into memory (as a `DataTree`), and close a dataset from the online repository |
| 352 | (requires internet). |
| 353 | |
| 354 | If a local copy is found then always use that to avoid network traffic. |
| 355 | |
| 356 | Available datasets: |
| 357 | |
| 358 | * ``"imerghh_730"``: GPM IMERG Final Precipitation L3 Half Hourly 0.1 degree x 0.1 degree V07 from 2021-08-29T07:30:00.000Z |
| 359 | * ``"imerghh_830"``: GPM IMERG Final Precipitation L3 Half Hourly 0.1 degree x 0.1 degree V07 from 2021-08-29T08:30:00.000Z |
| 360 | * ``"air_temperature"``: NCEP reanalysis subset |
| 361 | * ``"air_temperature_gradient"``: NCEP reanalysis subset with approximate x,y gradients |
| 362 | * ``"basin_mask"``: Dataset with ocean basins marked using integers |
| 363 | * ``"ASE_ice_velocity"``: MEaSUREs InSAR-Based Ice Velocity of the Amundsen Sea Embayment, Antarctica, Version 1 |
| 364 | * ``"rasm"``: Output of the Regional Arctic System Model (RASM) |
| 365 | * ``"ROMS_example"``: Regional Ocean Model System (ROMS) output |
| 366 | * ``"tiny"``: small synthetic dataset with a 1D data variable |
| 367 | * ``"era5-2mt-2019-03-uk.grib"``: ERA5 temperature data over the UK |
| 368 | * ``"eraint_uvz"``: data from ERA-Interim reanalysis, monthly averages of upper level data |
| 369 | * ``"ersstv5"``: NOAA's Extended Reconstructed Sea Surface Temperature monthly averages |
| 370 | |
| 371 | Parameters |
| 372 | ---------- |
| 373 | name : str |
| 374 | Name of the file containing the dataset. |
| 375 | e.g. 'air_temperature' |
| 376 | cache_dir : path-like, optional |
| 377 | The directory in which to search for and write cached data. |
| 378 | cache : bool, optional |
| 379 | If True, then cache data locally for use on subsequent calls |
| 380 | **kws : dict, optional |
| 381 | Passed to xarray.open_datatree |
| 382 | |
| 383 | See Also |
| 384 | -------- |
| 385 | tutorial.open_datatree |
| 386 | open_datatree |
| 387 | """ |
| 388 | with open_datatree(*args, **kwargs) as ds: |
| 389 | return ds.load() |
nothing calls this directly
no test coverage detected
searching dependent graphs…