GCPy: Python toolkit for GEOS-Chem

<p> <a href="https://github.com/geoschem/gcpy/releases"><img src="https://img.shields.io/github/v/release/geoschem/gcpy?label=Latest%20Stable%20Release" alt="Latest release" /></a> <a href="https://anaconda.org/conda-forge/geoschem-gcpy"> <img src="https://anaconda.org/conda-forge/geoschem-gcpy/badges/version.svg" alt="Anaconda version" /> </a> <a href="https://img.shields.io/pypi/v/geoschem-gcpy"><img src="https://img.shields.io/pypi/v/geoschem-gcpy" alt="PyPI version" /></a> <a href="https://github.com/geoschem/gcpy/releases/"><img src="https://img.shields.io/github/release-date/geoschem/gcpy" alt="Release date" /></a> <br /> <a href="https://anaconda.org/conda-forge/geoschem-gcpy"> <img src="https://anaconda.org/conda-forge/geoschem-gcpy/badges/platforms.svg" alt="Platforms" /> </a> <a href="https://doi.org/10.5281/zenodo.3689589"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.3689589.svg" alt="DOI" /></a> <a href="https://github.com/geoschem/gcpy/blob/main/LICENSE.txt"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License" /></a> <a href="https://gcpy.readthedocs.io/en/latest/"><img src="https://img.shields.io/readthedocs/gcpy?label=ReadTheDocs" alt="ReadTheDocs" /></a> <br /> <a href="https://github.com/geoschem/gcpy/actions/workflows/build-gcpy-environment-py312.yml"><img src="https://github.com/geoschem/gcpy/actions/workflows/build-gcpy-environment-py312.yml/badge.svg" alt="build-gcpy-environment-py312" /></a> <a href="https://github.com/geoschem/gcpy/actions/workflows/build-gcpy-environment-py313.yml"><img src="https://github.com/geoschem/gcpy/actions/workflows/build-gcpy-environment-py313.yml/badge.svg" alt="build-gcpy-environment-py313" /></a> <br /> <a href="https://github.com/geoschem/gcpy/actions/workflows/build-rtd-environment.yml"><img src="https://github.com/geoschem/gcpy/actions/workflows/build-rtd-environment.yml/badge.svg" alt="build-rtd-environment" /></a> <a href="https://anaconda.org/conda-forge/geoschem-gcpy"><img src="https://anaconda.org/conda-forge/geoschem-gcpy/badges/downloads.svg" alt="Downloads" /> </a> </p>

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 for 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 instead.
   • Also see our Work with netCDF files guide at geos-chem.readthedocs.io

2. Statistical analysis:

   • Instead, use statistical tools such as:
     • Use scipy
     • scikit-learn
     • R
     • etc

3. Machine Learning:

   • Instead, use machine learning tools such as:
     • pytorch,
     • tensorflow
     • julia
     • etc.

Documentation:

For more information on installing and using GCPy, visit the official documentation at gcpy.readthedocs.io.

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.