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 notebook

• AMOCarray 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
  • Monthly Anomalies Overview

Data format

• Data Format Documentation Overview
  • Understanding the Documentation Structure
  • Workflow Overview
  • Key Concepts
  • Getting Started
  • Questions and Contributions
• Array Format (Native / Original)
  • OSNAP Original Data Format
  • RAPID Original Data Format
  • MOVE Original Data Format
  • SAMBA Original Data Format
  • 41°N Original Data Format
  • DSO Original Data Format
  • FW2015 Original Data Format
  • MOCHA Original Data Format
• OceanSITES Format for AMOC Arrays
  • File naming
  • Global Metadata
  • Dimension and definition
  • Coordinates
  • Geophysical variables
  • AMOC array data
  • References
• Converting to OceanSITES format
  • OSNAP conversion thoughts
  • RAPID conversion thoughts
  • MOVE conversion thoughts
  • SAMBA conversion thoughts
• AMOCarray Format AC1
  • 1. Overview
  • 2. File Format
  • 3. Variables
  • 4. Global Attributes
  • 5. Variable Attributes
  • 6. Metadata Requirements
  • 7. Validation Rules
  • 8. Examples
  • 9. Conversion Tool
  • 10. Notes
  • 11. Provenance and Attribution

Help and reference

• GitHub Repo
• Controlled Vocabularies
  • Coordinates
  • Temperature
  • Salinity
  • Pressure
  • Density
  • Velocity
  • Transport
  • Freshwater Transport
  • Heat Transport
• Units Reference: for AC1
  • Variables
  • Mapping of Custom Conversions
  • SI Unit Prefixes
• Variable Names
  • Temperature
  • Salinity
  • Pressure
  • Density
  • Velocity
  • Transport

Developers' guide

• Developer Guide for amocatlas
  • Table of Contents
  • 1. Quickstart: First Contribution
  • 2. Project Overview
  • 3. Project Structure
    • Project Management and Configuration Files
    • Core Modules
  • 4. Setting Up Development Environment
    • Step 1: Clone the repository
    • Step 2: Set up a virtual environment
    • Step 3: Install dependencies
    • Step 4: (Optional) Install pre-commit hooks manually
    • Step 5: Build the documentation (optional)
  • 5. Development Workflow
    • Branching Model
    • Fork & Pull Requests
    • Keeping Your Fork Up To Date
  • 6. Ignoring Local Files: .gitignore vs .git/info/exclude
    • .gitignore
    • .git/info/exclude
    • Best Practice
  • 7. Commit Message Style Guide
    • Format
    • Types
    • Examples
    • Why this matters
  • 8. Logging and Debugging
    • How logging works
    • Enabling and disabling logging
    • Writing logs in modules
    • Log levels
    • Best practices
  • 9. Troubleshooting
    • Pre-commit not running?
    • VSCode virtualenv not recognised?
    • Tests failing due to missing data?
    • Pre-commit pytest hook fails but pytest passes manually?
    • My commits are blocked by pre-commit errors?
  • 10. Further Resources
• Collaborating with git: Basic workflow
  • 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 Coding Conventions
  • Python Style
    • Function Definitions
    • Function Naming
    • Docstrings
    • Line Length
    • Code Formatter
    • Imports
  • Xarray Dataset Style
    • Variables, Dimensions, Coordinates
    • Attributes
    • Notes
  • Miscellaneous
    • Pre-commit Workflow
    • Logging
    • Error Handling
  • Future Considerations
• Project Housekeeping Checklist
  • Adding a New Package
  • Updating Dependencies
  • Cleaning or Recreating the Environment
  • Pre-commit and Tests
  • Documentation
  • Before Merging a Branch

Indices and tables

• Index

• Module Index

• Search Page