regionate: a package for creating xgcm-grid consistent regional masks and boundaries

Contents:

• Installation
  • Requirements
  • Installation from Conda Forge
  • Installation from Pip
  • Installation from GitHub
• Horizontal convergence of thickness fluxes
  • Analysis of vertically-integrated thickness budget
• Horizontal convergence of vertically-integrated heat fluxes
  • 1. Load data
  • 2. Explanatory analysis of the heat budget terms
  • 3. Regional heat budgets
• Corner case: bipolar grid fold
  • 0. Load data
  • 1. Determine a mask for the region of interest.
  • 2. We use regionate to find the sections that bound the region
  • 3. We use sectionate to compute the advective heat fluxes that converge into the region.
  • 4. We verify our calculation by comparing against the volume integral of the masked tendency terms
  • 5. The pay-off: understanding advective tendencies by tracing them back to boundary fluxes
• Regions bounded by a series of named sections
  • 1. Load data
  • 2. Define the BoundedRegion
  • 3. Use the BoundedRegion’s mask to compute the net heat flux convergence
  • 4. Use the grid indices of the BoundedRegion’s boundary to compute convergent heat fluxes along the boundary
  • 5. Testing that our methods satisfy the divergence theorem on the model grid