Skip to content

jmoch1214/gcpy

 
 

Repository files navigation

GCPy: Python toolkit for GEOS-Chem

License

GCPy is a Python-based toolkit containing useful functions and routines for working with GEOS-Chem, meant to update and replace the IDL-based GAMAP utility. While not a complete re-write of GAMAP, GCPy aims to build on the well-established scientific python technical stack, leveraging tools like cartopy and xarray to simplify the task of working with model output and performing atmospheric chemistry analyses.

This package is comprised of two major components:

  1. A library of functions, implementing some of the core chemistry and thermodynamic calculations in GEOS-Chem for use outside of the model
  2. Documentation including long-form articles, interactive notebooks, and short example snippets illustrating workflows using Python and GCPy

Requirements

GCPy is built on top of Python 3 and the scientific Python / NumPy stack, including

To create an environment for working with GCPy, we recommend using the Anaconda Python distribution or curating your own virtualenv or conda environment. Please see gcpy/environment/environment.yml for an example.

Installation

At the moment, the easiest way to install GCPy is directly from our GitHub repository.

$ git clone https://github.com/geoschem/gcpy.git gcpy

Currently, GCPy is not available via conda-forge or PyPI, but we anticipate posting early versions of the package to those resources eventually.

License

GCPy is distributed under the MIT license. Please read the license documents LICENSE.txt and AUTHORS.txt, which are located in the root folder.

Contact

For more information, please contact the GEOS-Chem Support Team or reach out to us on the GEOS-Chem Wiki.

About

Python toolkit for GEOS-Chem

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.7%
  • Jupyter Notebook 1.3%