read module

The intuitive API for AMOCatlas (v0.2.0+). Returns standardized, analysis-ready data by default.

Key Features

  • Standardized by default: Consistent variable names, metadata, and units following oceanographic conventions

  • Single dataset return: Returns one dataset by default (most common use case)

  • IDE-friendly: Autocompletion support for array names and parameters

  • Flexible: Use raw=True to get data in original file formats when needed

Quick Examples

Basic usage (recommended):

from amocatlas import read

# Get standardized, analysis-ready data
rapid_data = read.rapid()                    # Single dataset
osnap_data = read.osnap(version="2025")      # Version parameter

# Get all files for power users
all_rapid = read.rapid(all_files=True)       # List of datasets

# Get raw data when needed
raw_data = read.rapid(raw=True)              # Original format

Available Array Functions

amocatlas.read.rapid(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load RAPID 26°N array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.move(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load MOVE 16°N array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.osnap(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load OSNAP array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (used for version selection). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.samba(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load SAMBA 34.5°S array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.arcticgateway(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Arctic Gateway array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.fw2015(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Frajka-Williams 2015 array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.mocha(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load MOCHA array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.wh41n(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load 41°N array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.dso(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Denmark Strait Overflow array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.noac47n(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load 47°N array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.fbc(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Faroe Bank Channel array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.calafat2025(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Calafat et al. 2025 array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.zheng2024(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Zheng et al. 2024 array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.nac(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load North Atlantic Current array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.sf2021(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Sanchez-Franks et al. 2021 array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.lebras35n(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load Le Bras et al. 2023 at 35°N array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.axmoc22s(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load AXMOC 22.5°S array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting

amocatlas.read.axmoc34s(source: str | Path | None = None, file_list: str | List[str] | None = None, transport_only: bool = True, all_files: bool = False, raw: bool = False, data_dir: str | Path | None = None, redownload: bool = False, version: str = None, track_added_attrs: bool = False) → Dataset | List[Dataset]

Load AXMOC 34.5°S array data.

By default, returns standardized, analysis-ready data with consistent variable names, metadata, and units following oceanographic conventions. Use raw=True to get data in original format from the source files.

Parameters:

  • source (str, Path, or None, optional) – URL or local path to the data source.

  • file_list (str, list of str, or None, optional) – Specific files to load. Defaults to transport files.

  • transport_only (bool, optional) – If True, load only transport data. Default: True.

  • all_files (bool, optional) – If True, return list of all datasets. If False, return single dataset. Default: False.

  • raw (bool, optional) – If True, return data in original format without standardization. If False (default), apply standardization for analysis-ready data.

  • data_dir (str, Path, or None, optional) – Local directory for data storage.

  • redownload (bool, optional) – Force redownload of data. Default: False.

  • version (str, optional) – Dataset version (ignored for this array). Default: None.

  • track_added_attrs (bool, optional) – INTERNAL USE ONLY - Track which attributes were added during metadata enrichment. When True, embeds a temporary ‘_amocatlas_metadata_changes’ attribute in each returned dataset containing {“added”: […], “modified”: […]}. This attribute should be extracted and removed by calling code (e.g., report generation). Not intended for end users. Default: False.

Returns:

Standardized dataset (default) or raw dataset if raw=True. Single dataset by default, or list of datasets if all_files=True.

Return type:

xr.Dataset or list of xr.Dataset

Notes

Standardization includes: - Consistent variable names across arrays - Proper CF-compliant metadata and attributes - Standardized units following oceanographic conventions - Additional quality control and formatting