amocarray

Basic repository for reading AMOC transport (volume transport only) from arrays.

https://github.com/amoccommunity/amocarray

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic repository for reading AMOC transport (volume transport only) from arrays.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 5
  • Open Issues: 9
  • Releases: 6
Created 11 months ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Citation

README.md

MOC transports

Clean, modular loading of AMOC observing array datasets, with optional structured logging and metadata enrichment.

AMOCarray provides a unified system to access and process data from major Atlantic Meridional Overturning Circulation (AMOC) observing arrays: - MOVE (16°N) - RAPID (26°N) - OSNAP (Subpolar North Atlantic) - SAMBA (34.5°S)

The project emphasizes clarity, reproducibility, and modular design, with per-dataset logging, metadata handling, and testable utilities.

This is a work in progress, all contributions welcome!

Install

Install from PyPI (https://pypi.org/project/amocarray/) with sh python -m pip install amocarray

Documentation

Documentation is available at https://amoccommunity.github.io/amocarray.

Check out the demo notebook notebooks/demo.ipynb for example functionality.

As input, amocarray downloads data from the observing arrays.

Quickstart

Load a sample dataset

```python from amocarray import readers

Load RAPID sample dataset

ds = readers.loadsampledataset("rapid") print(ds) ```

Load a full dataset

```python from amocarray import readers

datasets = readers.load_dataset("osnap") for ds in datasets: print(ds) `` A*.logfile will be written tologs/` by default.

Data will be cached in ~/.amocarray_data/ unless you specify a custom location.

Project structure

amocarray/ │ ├── readers.py # Orchestrator for loading datasets ├── read_move.py # MOVE reader ├── read_rapid.py # RAPID reader ├── read_osnap.py # OSNAP reader ├── read_samba.py # SAMBA reader │ ├── utilities.py # Shared utilities (downloads, parsing, etc.) ├── logger.py # Structured logging setup │ └── tests/ # Unit tests

Roadmap

  • [ ] Add test coverage for utilities and readers
  • [ ] Add dataset summary output at end of load_dataset()
  • [x] Optional global logging helpers (disablelogging(), enablelogging())
  • [ ] Extend loadsampledataset() to support all arrays
  • [x] Metadata enrichment (source paths, processing dates)
  • [ ] Clarify separation between added metadata and original metadata

Contributing

All contributions are welcome! See contributing for more details.

To install a local, development version of amocarray, clone the repository, open a terminal in the root directory (next to this readme file) and run these commands:

sh git clone https://github.com/AMOCcommunity/amocarray.git cd amocarray pip install -r requirements-dev.txt pip install -e . This installs amocarray locally. The -e ensures that any edits you make in the files will be picked up by scripts that impport functions from glidertest.

You can run the example jupyter notebook by launching jupyterlab with jupyter-lab and navigating to the notebooks directory, or in VS Code or another python GUI.

All new functions should include tests. You can run tests locally and generate a coverage reporrt with: sh pytest --cov=amocarray --cov-report term-missing tests/

Try to ensure that all the lines of your contribution are covered in the tests.

 Initial plans

The initial plan for this repository is to simply load the volume transports as published by different AMOC observing arrays and replicate (update) the figure from Frajka-Williams et al. (2019) 10.3389/fmars.2019.00260.

image

Acknowledgements

  • MOVE data: NOAA Climate Program Office and German Bundesministerium für Bildung und Forschung.
  • OSNAP data: www.o-snap.org
  • SAMBA data: NOAA AOML, Met Office, and associated research projects.
  • RAPID data: RAPID-MOCHA-WBTS collaboration.

Dataset access and processing via AMOCarray.

Owner

  • Name: AMOC community
  • Login: AMOCcommunity
  • Kind: organization

A github community for analysis of the Atlantic meridional overturning circulation.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Frajka-Williams
  given-names: Eleanor
  orcid: https://orcid.org/0000-0001-8773-7838
  affiliation: University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
- family-names: Schmitz
  given-names: Isabelle
  orcid: https://orcid.org/0009-0009-1369-1748
  affiliation: University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
title: amocarray
version: 0.0.2
date-released: 2025-04-12
url: https://github.com/AMOCcommunity/amocarray

GitHub Events

Total
  • Create event: 40
  • Issues event: 33
  • Release event: 6
  • Watch event: 2
  • Delete event: 28
  • Issue comment event: 15
  • Push event: 128
  • Pull request review event: 21
  • Pull request review comment event: 17
  • Pull request event: 79
  • Fork event: 4
Last Year
  • Create event: 40
  • Issues event: 33
  • Release event: 6
  • Watch event: 2
  • Delete event: 28
  • Issue comment event: 15
  • Push event: 128
  • Pull request review event: 21
  • Pull request review comment event: 17
  • Pull request event: 79
  • Fork event: 4

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 42 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
  • Total maintainers: 1
pypi.org: amocarray

Python project to read data from arrays measuring the Atlantic meridional overturning circulation

  • Documentation: https://amocarray.readthedocs.io/
  • License: MIT License Copyright (c) 2024 Eleanor Frajka-Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.0.4
    published 8 months ago
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 42 Last month
Rankings
Dependent packages count: 9.3%
Forks count: 24.3%
Average: 31.9%
Stargazers count: 41.4%
Dependent repos count: 52.5%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v2.0.1 composite
.github/workflows/docs_deploy.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v2.0.1 composite
  • peaceiris/actions-gh-pages v4 composite
.github/workflows/pypi.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
requirements-dev.txt pypi
  • cartopy * development
  • cmocean * development
  • gsw * development
  • importlib_resources * development
  • jupyterlab * development
  • matplotlib * development
  • myst-nb * development
  • nbconvert * development
  • nbsphinx * development
  • netcdf4 * development
  • numpy * development
  • pandas * development
  • pooch * development
  • pypandoc * development
  • pytest * development
  • pytest-cov * development
  • scipy * development
  • sphinx * development
  • sphinx-rtd-theme * development
  • tqdm * development
  • xarray * development
requirements.txt pypi
  • cartopy *
  • cmocean *
  • gsw *
  • matplotlib *
  • netcdf4 *
  • numpy *
  • pandas *
  • pooch *
  • scipy *
  • tqdm *
  • xarray *