emsarray.tutorial

Contents

emsarray.tutorial#

Useful functions for writing examples in the documentation or writing tutorials for new users.

emsarray.tutorial.open_dataset(name, **kwargs)#

Open one of the example datasets.

Example datasets will be downloaded from the dataset repository and cached locally. Refer to that repository for more information, including where the datasets were sourced from and full licensing details.

The example datasets that are available are:

austen

A day of the AUSTEn National Tidal model data. This dataset is defined on an unstructured grid.

bran2020

A small sample of the Bluelink Reanalysis 2020 (BRAN2020) ocean dataset. This dataset is defined on a rectangular grid with one dimensional coordinates, handled by the CFGrid1D convenion.

kgari

A subset of the Great Barrier Reef 4km (GBR4) v2.0 model, part of the eReefs data. This subset is centred around K’gari. This dataset is defined on a curvilinear grid with two dimensional coordinates, handled by the CFGrid2D convention. Temperature, sea surface height, and current variables are included.

gbr4

A subset of the Great Barrier Reef 4km (GBR4) v2.0 model, part of the eReefs data. This dataset is defined on a curvilinear grid with two dimensional coordinates, handled by the CFGrid2D convention. Temperature, sea surface heigh, and salinity variables are included.

Parameters:
Returns:

xarray.Dataset – The example dataset, after being downloaded and opened by xarray.

Example

import emsarray
kgari = emsarray.tutorial.open_dataset('kgari')
kgari.ems.plot(kgari['temp'].isel(time=0, k=-1))
Contents