MPAS-Tools

MPAS-Tools includes a python package, compiled Fortran, C and C++ tools, and scripts for supporting initialization, visualization and analysis of Model for Prediction Across Scales (MPAS) components. These tools are used by the COMPASS (Configuring of MPAS Setups) framework within MPAS-Model used to create ocean and land-ice test cases, the MPAS-Analysis package for analyzing simulations, and in other MPAS-related workflows.

User's Guide

• Mesh Creation
  • Uniform, Planar Meshes
  • Building a JIGSAW Mesh
  • Mesh Definition Tools
  • Signed Distance Functions
• Mesh Conversion
  • Mesh Converter
  • Cell Culler
  • Mask Creator
  • Mask Creation with Python Multiprocessing
  • Culling MPAS Datasets
  • Merging and Splitting
  • Translation
  • Converting Between Mesh Formats
• Interpolation
• CIME Constants
• Config files
  • Comments in config files
• Logging
  • Using logging
  • Logging subprocess calls
• Transects
  • Subdividing transects
  • Low-level functions
• Vector Operations
  • Vector Class
  • Vector Reconstructions
• Visualization
  • ParaView VTK Extractor
  • MPAS Mesh to Triangles
  • Colormaps

Landice Tools

• Visualization
  • Plotting Landice Transects
  • Plotting Landice Maps
  • Plotting Landice Grounding Lines

Ocean Tools

• Ocean Mesh Creation
• Coastal Tools
  • Refining a Mesh
  • Creating a Background Mesh
  • Extracting Coastlines
  • Computing Distance to Coast
  • Blending Cell Widths
  • Regions
• Coastline Alteration
  • Adding Land Blockages
  • Masking Land-locked Cells
  • Widening Transects
• Meridional Overturning Circulation
  • Building MOC Basins
  • Adding Southern Transects
  • Building MOC Basins and Transects Together
• Adding a Depth Coordinate
  • Adding a 1D depth coordinate
  • Adding a 3D zMid coordinate
  • Writing a time-dependent, 3D zMid variable
• Computing streamfunctions
  • Computing the barotropic streamfunction
• Visualization
  • Plotting Ocean Transects

Sea-ice Tools

• Mask
  • Extending a Mask
• Mesh
  • MPAS-Seaice SCRIP files
  • SCRIP files for 2D grids
• Graph partitioning
  • Running from compass
  • Conda environment
  • Graph partition tools
  • Graph partition function
• Region masks
  • Make a region mask for partitioning
• Regrid
  • Regridding between MPAS-Seaice meshes

Developer's Guide

• Making Changes to mpas_tools
  • Entry Points
  • Dependencies
  • Updating the Version
• Testing Changes to mpas_tools
  • Removing the test environment
• Building the Documentation
• API reference
  • MPAS mesh tools
  • Landice Tools
  • Ocean Tools
  • Sea-ice Tools
  • Logging
  • Transects
  • Vector
  • Visualization
  • Tests

Indices and tables

• Index

Authors

• Main Authors
• Contributors

Versions

• Versions