U Cv f3% @sdZddlmZddlZddlZddlZddlmZddlZ ddl m Z ddl mZddlmZddlmZer|dd l mZd Zd Zd Zd dZiZdddZdddddddddd ZddZd+dddddddddd Z d,d!d"Zdd#d$d%Zdd&d'dd(d)d*ZdS)-zR Useful for: * users learning xarray * building tutorials in the documentation. ) annotationsN) TYPE_CHECKING) open_dataset) open_rasterio) DataArray)Dataset)T_EngineZxarray_tutorial_dataz%https://github.com/pydata/xarray-dataZmastercCs6ddl}t|tjr t|}n|dkr2|t}|S)Nr)pooch isinstanceosPathLikefspathZos_cache_default_cache_dir_name)pathr r3/tmp/pip-unpacked-wheel-h316xyqg/xarray/tutorial.py_construct_cache_dirs    rzFhttps://github.com/rasterio/rasterio/raw/1.2.1/tests/data/RGB.byte.tifzChttps://github.com/rasterio/rasterio/raw/1.2.1/tests/data/shade.tif)zRGB.byteZshade) Zair_temperatureZair_temperature_gradientZASE_ice_velocityZ basin_maskZersstv5ZrasmZ ROMS_exampleZtinyZ eraint_uvzc Cst|}|dkrfz ddl}WnFtk rdz ddl}Wn$tk r^td|dYnXYnX|dkrz ddl}WnFtk rz ddl}Wn$tk rtd|dYnXYnXdS)Nrrzopening tutorial dataset z2 requires either scipy or netCDF4 to be installed.rz5 requires either h5netcdf or netCDF4 to be installed.) file_formatsgetscipy ImportErrornetCDF4h5netcdf)nameversionrrrrrr_check_netcdf_engine_installed<s*       rT)enginestrboolzNone | str | os.PathLikerr)rcache cache_dirrreturnc Ksz ddl}Wn,tk r8}ztd|W5d}~XYnX|}|dt|}|tkrft|}n\t|} | jsd} |dkrt || | } n| jdkr|dkrd}t dt d | j }|j|d|d } t| fd |i|} |s| } t| | S) a 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_temperature"``: NCEP reanalysis subset * ``"air_temperature_gradient"``: NCEP reanalysis subset with approximate x,y gradients * ``"basin_mask"``: Dataset with ocean basins marked using integers * ``"ASE_ice_velocity"``: MEaSUREs InSAR-Based Ice Velocity of the Amundsen Sea Embayment, Antarctica, Version 1 * ``"rasm"``: Output of the Regional Arctic System Model (RASM) * ``"ROMS_example"``: Regional Ocean Model System (ROMS) output * ``"tiny"``: small synthetic dataset with a 1D data variable * ``"era5-2mt-2019-03-uk.grib"``: ERA5 temperature data over the UK * ``"eraint_uvz"``: data from ERA-Interim reanalysis, monthly averages of upper level data * ``"ersstv5"``: NOAA's Extended Reconstructed Sea Surface Temperature monthly averages Parameters ---------- name : str Name of the file containing the dataset. e.g. 'air_temperature' cache_dir : path-like, optional The directory in which to search for and write cached data. cache : bool, optional If True, then cache data locally for use on subsequent calls **kws : dict, optional Passed to xarray.open_dataset See Also -------- tutorial.load_dataset open_dataset load_dataset rNzhtutorial.open_dataset depends on pooch to download and manage datasets. To proceed please install pooch.WARNINGz.ncz.gribZcfgribz/raw//urlZ known_hashrr)r r get_loggersetLevelr external_urlspathlibPathsuffixr with_suffixbase_urlrrretrieve _open_datasetloadunlink) rr!r"rkwsr eloggerr'rZdefault_extensionfilepathdsrrrrWs:,      rc Kstjdtddz ddl}Wn,tk rH}ztd|W5d}~XYnX|}|dt|}t |}|dkrt d||j |d|d } t | f|} |s| } t| | S) am Open a rasterio dataset from the online repository (requires internet). .. deprecated:: 0.20.0 Deprecated in favor of rioxarray. For information about transitioning, see: https://corteva.github.io/rioxarray/stable/getting_started/getting_started.html If a local copy is found then always use that to avoid network traffic. Available datasets: * ``"RGB.byte"``: TIFF file derived from USGS Landsat 7 ETM imagery. * ``"shade"``: TIFF file derived from from USGS SRTM 90 data ``RGB.byte`` and ``shade`` are downloaded from the ``rasterio`` repository [1]_. Parameters ---------- name : str Name of the file containing the dataset. e.g. 'RGB.byte' cache_dir : path-like, optional The directory in which to search for and write cached data. cache : bool, optional If True, then cache data locally for use on subsequent calls **kws : dict, optional Passed to xarray.open_rasterio See Also -------- xarray.open_rasterio References ---------- .. [1] https://github.com/rasterio/rasterio zopen_rasterio is Deprecated in favor of rioxarray. For information about transitioning, see: https://corteva.github.io/rioxarray/stable/getting_started/getting_started.html) stacklevelrNzitutorial.open_rasterio depends on pooch to download and manage datasets. To proceed please install pooch.r$zunknown rasterio dataset: r&)warningswarnDeprecationWarningr rr(r)rexternal_rasterio_urlsr ValueErrorr0_open_rasterior2r+r,r3) rrr!r"r4r r5r6r'r7Zarrrrrrs2-    r)r#c Os*t||}|W5QRSQRXdS)aS Open, load into memory, 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: * ``"air_temperature"``: NCEP reanalysis subset * ``"air_temperature_gradient"``: NCEP reanalysis subset with approximate x,y gradients * ``"basin_mask"``: Dataset with ocean basins marked using integers * ``"rasm"``: Output of the Regional Arctic System Model (RASM) * ``"ROMS_example"``: Regional Ocean Model System (ROMS) output * ``"tiny"``: small synthetic dataset with a 1D data variable * ``"era5-2mt-2019-03-uk.grib"``: ERA5 temperature data over the UK * ``"eraint_uvz"``: data from ERA-Interim reanalysis, monthly averages of upper level data * ``"ersstv5"``: NOAA's Extended Reconstructed Sea Surface Temperature monthly averages Parameters ---------- name : str Name of the file containing the dataset. e.g. 'air_temperature' cache_dir : path-like, optional The directory in which to search for and write cached data. cache : bool, optional If True, then cache data locally for use on subsequent calls **kws : dict, optional Passed to xarray.open_dataset See Also -------- tutorial.open_dataset open_dataset load_dataset N)rr2)argskwargsr8rrr load_datasets% rC)seedz None | int)rDr#c Cs tj|}ttddddgddddgtdtdd dtdd |dd d }d |jd |j dd |j |j }d|j|j d|j |j }t ||d}ddddg|d<d|jj d<d|j j d<d|j j d<d|j j d<d|jj d<d|jj d<|S)z Create an example dataset. Parameters ---------- seed : int, optional Seed for the random number generation. r rxyzwrg?)rFrGrHrI)ZdimsZcoordsr9g@g)ABZoneZtwoZthreeZfiveZxunitsZunitsZyunitsZzunitsZwunitsZAunitsZBunits)nprandomZ default_rngrzerosZarangeZlinspaceZstandard_normalrFrGrHrIrattrsrLrM)rDrngrLrMr8rrrscatter_example_dataset s*     (       rS)TN)NTN)__doc__ __future__rr r+r;typingrZnumpyrNZxarray.backends.apirr1Zxarray.backends.rasterio_rr@Zxarray.core.dataarrayrZxarray.core.datasetrrrr/rrr*r>rrrCrSrrrrsT         T N)