GCPy: GEOS-Chem Python toolkit

Welcome to the GCPy ReadTheDocs documentation! This site provides documentation on the functionality of GCPy and instructions for common use cases.

GCPy is a Python-based toolkit containing useful functions for working specifically with the GEOS-Chem model of atmospheric chemistry and composition. GCPy is primarily used for plotting/tabling GEOS-Chem output and regridding input files in special cases.

For documentation on setting up and running GEOS-Chem please see our list of manuals for GEOS-Chem and related software.

Basic Usage of GCPy:

• About GCPy
  • What GCPy was intended to do
  • What GCPY was not intended to do
• Installing GCPy
  • Requirements
  • Steps to install Conda 4.12.0 with Miniconda
  • Steps to install GCPy and its dependencies
  • Upgrading GCPy versions
• Overview of Capabilities
  • Spatial Plotting
    • Single Panel Plots
    • Six Panel Comparison Plots
    • Comprehensive Benchmark Plotting
  • Table Creation
    • Budget Tables
    • Mass Tables
    • Emissions Tables
  • Regridding
    • General Regridding Rules

Usage Details:

• Plotting
  • compare_single_level and compare_zonal_mean
    • Shared structure
      • Arguments:
      • Shared keyword arguments:
    • compare_single_level
      • Function-specific keyword arguments:
    • compare_zonal_mean
      • Function-specific keyword arguments:
  • Single_panel
    • Arguments:
    • Function-specific return value:
  • Benchmark Plotting Functions
    • Shared structure of benchmark functions
      • Shared arguments:
      • Shared keyword arguments:
    • make_benchmark_aod_plots
    • make_benchmark_conc_plots
      • Function-specific keyword arguments:
      • Function-specific keyword args:
    • make_benchmark_jvalue_plots
      • Function-specific keyword args:
    • make_benchmark_wetdep_plots
      • Function-specific keyword args:
• Tabling
  • Emissions tables
    • Arguments:
    • Keyword arguments:
  • Mass Tables
    • Arguments:
    • Keyword arguments:
  • Operations Budget Tables
    • Arguments:
    • Keyword arguments:
  • Aerosol Budgets and Burdens
    • Arguments:
    • Keyword arguments:
• Regridding
  • Regridding Files - GEOS-Chem Classic
    • Required Arguments:
    • Optional arguments:
  • Regridding Files - GCHP
    • Required Arguments:
    • Optional arguments:
    • First Time Setup
    • Regridding
    • Standard Cubed-Sphere Regridding
    • Stretched Cubed-Sphere Regridding
  • Regridding for Plotting in GCPy
    • Pass stretched-grid file paths
    • Pass vertical grid parameters for non-72/47-level grids
    • Automatic regridding decision process

Example Scripts:

• Six Panel Plotting
• Single Panel Plotting
• Benchmark Plotting / Tabling
• Plot Timeseries
• Convert BPCH to NetCDF

Help & Reference:

• Report a Problem or Request a Feature
• Contribute to GCPy
• Editing these docs
• Releasing new versions