readers (Legacy API)

Legacy API that returns raw data. Still supported for backwards compatibility.

AMOCatlas data readers: unified interface for AMOC observing arrays.

This module provides the main interface for loading data from multiple Atlantic Meridional Overturning Circulation (AMOC) observing arrays. It serves as the orchestrator that routes requests to specific array readers and provides both sample and full dataset loading capabilities.

The module supports data from: - RAPID (26°N) - MOVE (16°N) - OSNAP (Subpolar North Atlantic) - SAMBA (34.5°S) - MOCHA, 41°N, DSO, and FW2015 arrays

Main functions: - load_dataset(): Load full datasets from any supported array - load_sample_dataset(): Load small sample datasets for testing

amocatlas.readers.load_dataset(array_name: str, source: str = None, file_list: str | list[str] = None, transport_only: bool = True, data_dir: str | Path | None = None, redownload: bool = False) → list[Dataset][source]

Load raw datasets from a selected AMOC observing array.

Deprecated since version This: function is deprecated and will be removed in a future version. Use the new intuitive API instead: amocatlas.read (e.g., amocatlas.read.rapid()).

Parameters:

  • array_name (str) – The name of the observing array to load. Options are: - ‘move’ : MOVE 16N array - ‘rapid’ : RAPID 26N array - ‘osnap’ : OSNAP array (2014-2022, configurable version via main reader) - ‘osnap_2025’ : OSNAP array (2014-2022, dedicated 2025 reader function) - ‘samba’ : SAMBA 34S array - ‘fw2015’ : FW2015 array - ‘41n’ : 41N array - ‘dso’ : DSO array - ‘calafat2025’ : CALAFAT2025 array - ‘zheng2024’ : ZHENG2024 array - ‘47n’ : 47N array - ‘fbc’ : Faroe Bank Channel overflow array - ‘arcticgateway’ : ARCTIC Gateway array

  • source (str, optional) – URL or local path to the data source. If None, the reader-specific default source will be used.

  • file_list (str or list of str, optional) – Filename or list of filenames to process. If None, the reader-specific default files will be used.

  • transport_only (bool, optional) – If True, restrict to transport files only.

  • data_dir (str, optional) – Local directory for downloaded files.

  • redownload (bool, optional) – If True, force redownload of the data.

Returns:

List of datasets loaded from the specified array.

Return type:

list of xarray.Dataset

Raises:

ValueError – If an unknown array name is provided.

amocatlas.readers.load_sample_dataset(array_name: str = 'rapid') → Dataset[source]

Load a sample dataset for quick testing.

Deprecated since version This: function is deprecated and will be removed in a future version. Use the new intuitive API instead: amocatlas.read (e.g., amocatlas.read.rapid()).

Currently supports: - ‘rapid’ : loads the ‘RAPID_26N_TRANSPORT.nc’ file

Parameters:

array_name (str, optional) – The name of the observing array to load. Default is ‘rapid’.

Returns:

A single xarray Dataset from the sample file.

Return type:

xr.Dataset

Raises:

ValueError – If the array_name is not recognised.