xmitgcm

xmitgcm is a python package for reading MITgcm binary MDS files into xarray data structures. By storing data in dask arrays, xmitgcm enables parallel, out-of-core analysis of MITgcm output data.

• Installation
  • Requirements
  • Installation via conda
  • Installation via pip
  • Installation from github
  • Running the test suite
• Quick Start
• Reading MDS Data
  • open_mdsdataset
  • Lazy Evaluation and Dask Chunking
  • Expected Files
  • Dimensions and Coordinates
  • Time
  • Grid Geometries
• Example Usage
  • Land Masks
  • Volume Weighting
  • netCDF conversion
• Use case: reading the full grid from MITgcm input files
  • Example 1: LLC90
  • Example 2: ASTE
• Use case: writing a binary input file for MITgcm
  • Simple case: a regular grid
  • More complicated case: a LLC grid
• Performance Issues
  • LLC Reading Strategies
  • Running xmitgcm on Pleaides
  • Example Pleiades Scripts
• llcreader
  • Limitations
  • Pre-Defined Models
  • Manual Dataset Creation
  • API Documentation
• Low Level Utilities
• Development
  • Release History
  • Develpment Workflow
  • Virtual Environment