Reference datasets

datasets.reference

datasets.reference

This module exposes the reference datasets used in OceanBench for OceanBench challenger to explore.

Functions

Name Description
glo12_analysis Open GLO12 analysis with as an xarray.Dataset.
glorys_reanalysis Open GLORYS reanalysis with as an xarray.Dataset.
glorys_reanalysis_1_degree Open the historical 1 degree GLORYS reanalysis as an xarray.Dataset.

glo12_analysis

datasets.reference.glo12_analysis()

Open GLO12 analysis with as an xarray.Dataset.

Returns

Name Type Description
Dataset The Dataset containing GLO12 analysis.

Examples

>>> glo12_analysis()
<xarray.Dataset> Size: 3TB
Dimensions:    (depth: 50, latitude: 2041, longitude: 4320, time: 366)
Coordinates:
  * depth      (depth) float32 200B 0.494 1.541 2.646 ... 5.275e+03 5.728e+03
  * latitude   (latitude) float32 8kB -80.0 -79.92 -79.83 ... 89.83 89.92 90.0
  * longitude  (longitude) float32 17kB -180.0 -179.9 -179.8 ... 179.8 179.9
  * time       (time) datetime64[ns] 3kB 2024-01-01 2024-01-02 ... 2024-12-31
Data variables:
    thetao     (time, depth, latitude, longitude) float32 645GB dask.array<chunksize=(21, 1, 512, 2048), meta=np.ndarray>
    so         (time, depth, latitude, longitude) float32 645GB dask.array<chunksize=(21, 1, 512, 2048), meta=np.ndarray>
    uo         (time, depth, latitude, longitude) float32 645GB dask.array<chunksize=(21, 1, 512, 2048), meta=np.ndarray>
    vo         (time, depth, latitude, longitude) float32 645GB dask.array<chunksize=(21, 1, 512, 2048), meta=np.ndarray>
    zos        (time, latitude, longitude) float32 13GB dask.array<chunksize=(21, 1024, 2048), meta=np.ndarray>
Attributes:
    ...

glorys_reanalysis

datasets.reference.glorys_reanalysis()

Open GLORYS reanalysis with as an xarray.Dataset.

Returns

Name Type Description
Dataset The Dataset containing GLORYS reanalysis.

Examples

>>> glorys_reanalysis()
<xarray.Dataset> Size: 5TB
Dimensions:    (depth: 50, latitude: 2041, longitude: 4320, time: 366)
Coordinates:
  * depth      (depth) float32 200B 0.494 1.541 2.646 ... 5.275e+03 5.728e+03
  * latitude   (latitude) float32 8kB -80.0 -79.92 -79.83 ... 89.83 89.92 90.0
  * longitude  (longitude) float32 17kB -180.0 -179.9 -179.8 ... 179.8 179.9
  * time       (time) datetime64[ns] 3kB 2024-01-01 2024-01-02 ... 2024-12-31
Data variables:
    thetao     (time, depth, latitude, longitude) float64 1TB dask.array<chunksize=(28, 1, 512, 2048), meta=np.ndarray>
    so         (time, depth, latitude, longitude) float64 1TB dask.array<chunksize=(28, 1, 512, 2048), meta=np.ndarray>
    uo         (time, depth, latitude, longitude) float64 1TB dask.array<chunksize=(28, 1, 512, 2048), meta=np.ndarray>
    vo         (time, depth, latitude, longitude) float64 1TB dask.array<chunksize=(28, 1, 512, 2048), meta=np.ndarray>
    zos        (time, latitude, longitude) float64 26GB dask.array<chunksize=(28, 512, 2048), meta=np.ndarray>
Attributes:
    ...

glorys_reanalysis_1_degree

datasets.reference.glorys_reanalysis_1_degree()

Open the historical 1 degree GLORYS reanalysis as an xarray.Dataset.

This dataset is intended to support training on the 1 degree OceanBench track. It exposes the historical GLORYS reanalysis published at 1 degree resolution in the OceanBench public EDITO bucket.

Returns

Name Type Description
Dataset The Dataset containing the historical 1 degree GLORYS reanalysis.

Examples

>>> glorys_reanalysis_1_degree()
<xarray.Dataset> Size: 970GB
Dimensions:                          (time: 9861, depth: 50, latitude: 170,
                                      longitude: 360)
Coordinates:
  * depth                            (depth) float32 200B 0.494 ... 5.728e+03
  * latitude                         (latitude) float64 1kB -79.5 -78.5 ... 89.5
  * longitude                        (longitude) float64 3kB -179.5 ... 179.5
  * time                             (time) datetime64[ns] 79kB 1993-01-01 .....
Data variables:
    eastward_sea_water_velocity      (time, depth, latitude, longitude) float64 241GB dask.array<chunksize=(1, 1, 170, 360), meta=np.ndarray>
    northward_sea_water_velocity     (time, depth, latitude, longitude) float64 241GB dask.array<chunksize=(1, 1, 170, 360), meta=np.ndarray>
    sea_surface_height_above_geoid   (time, latitude, longitude) float64 5GB dask.array<chunksize=(1, 170, 360), meta=np.ndarray>
    sea_water_potential_temperature  (time, depth, latitude, longitude) float64 241GB dask.array<chunksize=(1, 1, 170, 360), meta=np.ndarray>
    sea_water_salinity               (time, depth, latitude, longitude) float64 241GB dask.array<chunksize=(1, 1, 170, 360), meta=np.ndarray>
Attributes:
    ...