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
  • License
  • Requesting support
  • Submitting new features
• Installing GCPy
  • Requirements
    • Check if Mamba is installed
    • Check if Conda is installed
  • Install MambaForge
    • MacOS
    • Linux and Windows Subsystem for Linux
  • 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
  • Six-panel comparison plots
    • Function compare_single_level
    • Function compare_zonal_mean
    • Shared structure
    • Example script
  • Single panel plots
    • Function: single_panel
• Regridding
  • Using Online Regridding Weights
    • gcpy.file_regrid required arguments:
    • gcpy.file_regrid optional arguments:
    • Examples
  • Using Offline Regridding Weights
    • gcpy.regrid_restart_file required arguments:
    • gcpy.regrid_restart_file optional arguments:
    • Example 1: Standard Lat-Lon to Cubed-Sphere Regridding
    • Example 2: Standard Cubed-Sphere to Cubed-Sphere Regridding
    • Example 3: Standard to 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
• Benchmarking
  • Location of benchmark plotting scripts
  • Steps to create benchmark plots
  • Benchmark plotting functions
    • make_benchmark_aod_plots
    • make_benchmark_conc_plots
    • make_benchmark_emis_plots
    • make_benchmark_jvalue_plots
    • make_benchmark_wetdep_plots
  • Benchmark tabling functions
    • make_benchmark_aerosol_tables
    • make_benchmark_emis_tables
    • make_benchmark_mass_tables
    • make_benchmark_mass_accumulation_tables
    • make_benchmark_mass_conservation_table
    • make_benchmark_oh_metrics
    • make_benchmark_operations_budget

Example Scripts:

• Six Panel Plotting
• Single Panel Plotting
• Plot Timeseries

Help & Reference:

• Contributing Guidelines
• Support Guidelines
• Editing these docs
• Releasing new versions