Welcome to GCPy’s documentation!

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 the GEOS-Chem Wiki.

Basic Usage of GCPy:

• About GCPy
  • What GCPY is
  • What GCPy was intended to do
  • What GCPY was not intended to do
• Getting Started with GCPy
  • Installing GCPy
    • Software Prerequisites
    • Installing GCPy for non-developers using Conda
    • Installing GCPy for developers
    • Manual install using source code (pre-1.0.0)
    • Optional extra Python libraries
  • Testing your GCPy installation
• 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:
      • DataArray or numpy array
      • ax : matplotlib axes
      • plot_type : str
      • grid : dict
      • gridtype : str
      • title : str
      • comap : matplotlib Colormap
      • norm : list
      • unit : str
      • extent : tuple
      • masked_data : numpy array
      • use_cmap_RdBu : bool
      • log_color_scale : bool
      • add_cb : bool
      • pres_range : list of int
      • pedge : numpy array
      • pedge_ind : numpy array
      • log_yaxis : bool
      • xtick_positions : list of float
      • xticklabels : list of str
      • sg_path : str
      • ll_plot_func : str
      • vert_params : list
      • pdfname : str
      • extra_plot_args : various
      • plot : matplotlib plot
  • Benchmark Plotting Functions
    • Shared structure
      • Arguments:
      • Shared keyword arguments:
    • make_benchmark_aod_plots
      • Function-specific keyword args:
    • make_benchmark_conc_plots
      • Function-specific keyword args:
    • make_benchmark_emis_plots
      • 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:
      • reflist: list of str
      • refstr : str
      • devlist : list of str
      • devstr : str
      • dst : str
      • refmet : str
      • devmet : str
      • overwrite : bool
      • ref_interval : list of float
      • dev_interval : list of float
      • spcdb_dir : str
  • Mass Tables
    • Arguments:
    • Keyword arguments:
      • reflist : str
      • refstr : str
      • dev : list of str
      • devstr : str
      • varlist : list of str
      • dst : str
      • subdst : str
      • overwrite : bool
      • verbose : bool
      • spcdb_dir : str
      • ref_met_extra : str
      • dev_met_extra : str
  • Operations Budget Tables
    • Arguments:
      • refstr : str
      • reffiles : list of str
      • devstr : str
      • devfiles : list of str
      • interval : float
      • benchmark_type : str
      • label : str
      • col_sections : list of str
      • operations : list of str
      • compute_accum : bool
      • require_overlap : bool
      • dst : str
      • species : list of str
      • overwrite : bool
  • Aerosol Budgets and Burdens
    • Arguments:
    • Keyword arguments:
      • devdir: str
      • devlist_aero : list of str
      • devlist_spc : list of str
      • devlist_met : list of str
      • devstr : str
      • year : str
      • days_per_mon : list of int
      • dst : str
      • overwrite : bool
      • is_gchp : bool
      • spcdb_dir : str
• 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
  • Regridding Files
    • Required Arguments:
    • Optional arguments:
      • fin : str
      • fout : str
      • dim_format_in : str
      • dim_format_out : str
      • cs_res_out : int
      • ll_res_out : str
      • sg_params_in : list[float, float, float]
      • sg_params_out : list[float, float, float]

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
• API Reference