Documentation

The ggcmpy package aims to be the place to collect various OpenGGCM related tools.

• Support for reading OpenGGCM data files as Xarray datasets.

  Xarray is essentially an extension of numpy arrays, adding additional information like dimension names and coordinates, and making many data analysis tasks much easier. This package allows to read OpenGGCM binary files (.iof, .3df, .p[xyz]_N) simply by ds = xr.open_dataset(filename).

• OpenGGCM-specific Xarray extensions

  • for now, this is limited to providing the mlts and colats coordinates in addition to the standard longs, lats.

• (TBD): OpenGGCM specific plotting support

• (TBD): Setting up an OpenGGCM run

  • Generating a runme
  • Generating a non-uniform grid
  • Preparing event solar wind data

• (external): Support for reading OpenGGCM XDMF/HDF5 data is available through xarray-pschdf5

• (external): Support for reading OpenGGCM ADIOS2 data is available through xarray-adios2

Needless to say, there is a lot of work the remains to be done, feedback / requests and help are always appreciated!