Welcome to amocatlas’s documentation!

amocatlas is a repository to access and work with array data from Atlantic meridional overturning circulation mooring arrays.

For recommendations or bug reports, please visit https://github.com/AMOCcommunity/amocatlas/issues/new

Getting started

• About AMOCatlas
  • What is this?
  • Why AMOC?
  • What arrays are included?
  • What can you do with it?
  • Getting started
  • Need help?
• Installation
  • Install for contributing

Demo notebooks

• AMOCatlas demo
  • Load RAPID 26°N
  • Load MOVE 16°N
  • Load OSNAP
  • Load SAMBA 34.5°S
  • Load FW2015
  • LOAD MOCHA 26.5°N
  • LOAD 41°N
  • LOAD DSO
  • LOAD CALAFAT2025
  • LOAD ZHENG2024
  • Monthly Anomalies Overview
• AMOCatlas conversion & compliance checker
  • Load RAPID 26°N
  • Step 2: Convert to AC1 Format
  • Demonstration: Working conversion with manual units fix
  • Step 3: Compliance Checking
• AMOC Publication Figures
  • 1. Load and Standardize Data
  • 2. Extract Time Series to Pandas DataFrames
  • 3. Bin Data to Monthly Resolution
  • 4. Apply Tukey Filtering
  • 5. Single Array Time Series Plots
• RAPID components plot
• Multi-array comparison plot - original data
  • 10. Summary
  • 9. Summary

Data format

• Data Format Documentation Overview
  • Understanding the Documentation Structure
  • Workflow Overview
  • Key Concepts
  • Getting Started
  • Questions and Contributions
• Array Format (Native / Original)
• Converting to OceanSITES format
• AMOCatlas Format AC1
  • 1. Overview & Context
  • 2. Key Design Decisions
  • 3. File Organisation & Naming
  • 4. Global Attributes
  • 5. Dimensions & Coordinates
  • 6. Data Variables & QC
  • 7. Conversion Tools and Implementation
  • 8. Examples and Use Cases
  • 9. Reference Tables
  • 10. Metadata Requirements and YAML Integration
  • 11. Future Development and Extensions
  • 12. Summary and Recommendations

Help and reference

• GitHub Repo
• amocatlas API
  • readers
  • standardise
  • plotters
  • writers
  • tools
  • utilities
• Reference: Vocabularies
  • Coordinates
  • Temperature
  • Salinity
  • Pressure
  • Density
  • Velocity
  • Transport
  • Freshwater Transport
  • Heat Transport
• Reference: Units
  • Variables
  • Mapping of Custom Conversions
  • SI Unit Prefixes
• Variable Names
  • Temperature
  • Salinity
  • Pressure
  • Density
  • Velocity
  • Transport

Developers' guide

• Developer Guide for AMOCatlas
  • Quickstart
  • Project Overview
    • Core Architecture
    • Package-Level Imports
  • Development Environment
    • Prerequisites
    • Setup Steps
    • Development Tools
    • PyGMT Installation Notes
  • Adding New Features
    • Adding a New Data Reader
    • Adding Visualization Functions
  • Code Standards
    • Python Style
    • Example Function:
    • Data Standards
    • Quality Checks
  • Git Workflow
    • Basic Workflow
    • Commit Message Format
    • Pull Request Process
  • Testing
    • Running Tests Locally
    • Writing Tests
    • GitHub Actions CI
    • Pre-commit Checks
  • PyGMT Development
  • Troubleshooting
    • Common Issues
  • Specialized Guides
  • Resources
• Git for Beginners: Workflow Guide
  • Forking & branching someone else’s repository
    • 1. Fork the repository
    • 2. Clone to your computer
    • 3. Find the clone on your computer
    • 4. Create a feature branch or just “branch” for edits
    • 5. Make an edit in the branch
    • 6. Commit the change in your branch
    • 7. Create a pull request to upstream main
    • 8. Compare pull request on GitHub.com
    • 9. Merge the pull request
    • 10. Rinse and repeat
• Extra GitHub features: Actions & Pages
  • This project’s Actions
  • For contributors
    • Check demo.ipynb
    • Check tests
    • Build docs
  • For maintainers
    • Build distribution
    • Publishing a release
• Project Maintenance Checklist
  • Dependencies
  • Environment Refresh
  • Pre-merge Checklist
  • Documentation

Indices and tables

• Index

• Module Index

• Search Page