gcm_toolkit

gcm_toolkit is an open-source python package to read, post-process, and plot 3D GCM data. The goal is to have an easy to use invironment for new GCM users, while allowing for direct access to the data for more experienced users.

gcm_toolkit originated from the need for a consistent and easy-to-share methodology for reading and analyzing the 3D circulation models of exoplanet atmospheres. Currently, the focus is on data produced by the MITgcm and its implementations for exoplanets ( see Carone et al., 2020 and Schneider et al., 2022). But we envision this package as a general tool for the analysis of data from different 3D GCMs.

gcm_toolkit is currently under development. Feel free to contribute!

Features (Current/Planned)

• Multiple read-in methods (currently only MITgcm)
• 'Tag' system for easy referencing of multiple models in memory
• Making use of xarray's intuitive system of multi-D arrays
• Quick plotting routines
  • isobaric slices
  • zonal means
  • evolution over time
• Direct data access for custom plotting and post-processing

Main Authors

• Aaron Schneider
• Sven Kiefer
• Robin Baeyens

Get Started

Read the docs

Installation

pip install gcm-toolkit

(Note the dash)

Packages needed

Please install the following packages beforehand:

general: xarray, netcdf4

exPERT/MITgcm - raw files: xmitgcm, xgcm, f90nml, cubedsphere

Running the first example

Check the get started in the docs

Miscellaneous Documentation

• All quantities are expressed in SI units.
• Latitudes run from -90° to 90° ; Longitudes run from -180° to 180°.
• The substellar point for tidally locked planets is located at (0°, 0°).
• The radius of the planet is defined at the bottom boundary of the vertical grid.

Contact

Feel free to contact one of the main authors: Aaron Schneider , Sven Kiefer, or Robin Baeyens.

Project url: https://github.com/exorad/gcm_toolkit