xmitgcm 0.5.0

Links

• HTML documentation: https://xmitgcm.readthedocs.org

• Issue tracker: https://github.com/MITgcm/xmitgcm/issues

• Source code: https://github.com/MITgcm/xmitgcm

Installation

conda install xarray dask

pip install xmitgcm

git clone https://github.com/MITgcm/xmitgcm.git
cd xmitgcm
python setup.py install

Quick Start

First make sure you understand what an xarray Dataset object is. Then find some MITgcm MDS data. If you don’t have any data of your own, you can download the xmitgcm test repositories To download the some test data, run the shell commands:

$ curl -L -J -O https://ndownloader.figshare.com/files/6494718
$ tar -xvzf global_oce_latlon.tar.gz

This will create a directory called global_oce_latlon which we will use for the rest of these examples. If you have your own data, replace this with the path to your mitgcm files.

To opean MITgcm MDS data as an xarray.Dataset, do the following in python:

from xmitgcm import open_mdsdataset
data_dir = './global_oce_latlon'
ds = open_mdsdataset(data_dir)

data_dir, should be the path (absolute or relative) to an MITgcm run directory. xmitgcm will automatically scan this directory and try to determine the file prefixes and iteration numbers to read. In some configurations, the open_mdsdataset function may work without further keyword arguments. In most cases, you will have to specify further details.

Consult the online documentation for more details.