API Reference

gcpy.append_grid_corners

Program to append corner longitudes and latitudes to an xarray dataset contianing cubed-sphere "stretched-grid" data.

gcpy.benchmark

Scripts and routines for generating plots and tables from GEOS-Chem benchmark simulation output.

gcpy.community

Community-created utilities.

gcpy.constants

Contains definitions of physical and chemical constants, as well as other needed global variables.

gcpy.cstools

Contains tools for working with cubed-sphere data.

gcpy.date_time

Internal utilities for managing datetime objects and strings

gcpy.examples

User examples that demonstrate the capabilities of GCPy.

gcpy.file_regrid(filein, fileout, ...[, ...])

Regrids an input file to a new horizontal grid specification and saves it as a new file.

gcpy.grid

Module containing variables and functions that define and manipulate GEOS-Chem horizontal and vertical grids

gcpy.grid_stretching_transforms

Functions to apply grid-stretching transforms.

gcpy.kpp

Python modules for analyzing output from KPP-Standalone box model simulations.

gcpy.plot

Modules containing core plotting functionality.

gcpy.profile

Utilities for analyzing results from the gprofng and Intel VTune code profilers.

gcpy.raveller_1D

Module containing functions to generate a satellite track file for cubed-sphere grids.

gcpy.regrid(dataset, output_template, ...)

Calculate and apply the regridding, based on passed regridding weights and input dataset attributes.

gcpy.regrid_restart_file(input_restart, ...)

Perform an end-to-end regridding from reading input gridded data and regridding weights to writing out the regridded data.

gcpy.units

Contains methods for converting the units of data.

gcpy.util

Internal utilities for helping to manage xarray and numpy objects used throughout GCPy

gcpy.vgrid_defs

Defines the Ap and Bp parameters that specify the GEOS-Chem vertical grid coordinates.