About GCPy

GCPy is a Python-based toolkit containing useful functions for working specifically with the GEOS-Chem model of atmospheric chemistry and composition.

GCPy aims to build on the well-established scientific Python technical stack, leveraging tools like cartopy, numpy, and xarray to simplify the task of working with GEOS-Chem model output and performing atmospheric chemistry analyses.

What GCPy was intended to do

1. Produce plots and tables from GEOS-Chem output using simple function calls.

2. Generate the standard evaluation plots and tables from GEOS-Chem benchmark simulations.

3. Obtain GEOS-Chem’s horizontal and vertical grid information.

4. Implement GCHP-specific regridding functionalities (e.g. cubed-sphere to lat-lon regridding).

5. Provide example scripts for creating specific types of plots or analysis from GEOS-Chem output.

6. Provide user-submitted scripts for specific applications related to GEOS-Chem and HEMCO.

What GCPy was not intended to do

1. General NetCDF file modification: (crop a domain, extract some variables):

   • Instead, use netCDF tools such as:

     • xarray

     • netCDF Operators (NCO)

     • Climate Data Operators (CDO)

   • Also see our Work with netCDF data guide at geos-chem.readthedocs.io.

2. Statistical analysis:

   • Instead, use statistical tools such as:

     • scipy

     • scikit-learn

     • R

     • etc.

3. Machine Learning:

   • Instead, use machine learning tools such as:

     • pytorch

     • tensorflow

     • julia

     • etc.

License

GCPy is distributed under the MIT license. Please see the GCPy license agreement and List of GCPy developers for more information.

Requesting support

To report a bug or suggest a new feature, please see our Support Guidelines.

Submitting new features

If you are interested in submitting code to GCPy, please see our Contributing Guidelines.