Difference between revisions of "Python tools for use with GEOS-Chem"

From Geos-chem
Jump to: navigation, search
(Third-party Python tools)
(GCPy)
Line 22: Line 22:
 
== GCPy ==
 
== GCPy ==
  
The GEOS-Chem Support Team is currently developing [https://github.com/geoschem/gcpy '''GCPy'''], which is a Python-based toolkit containing useful functions and routines for working with GEOS-Chem. GCPy is meant to update and replace the IDL-based GAMAP utility.  While not a complete re-write of the GAMAP IDL pacakage, 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.
+
The GEOS-Chem Support Team develops [https://github.com/geoschem/gcpy '''GCPy'''], which is a Python-based toolkit containing useful functions and routines for working with GEOS-Chem. GCPy is meant to update and replace the IDL-based GAMAP utility.  While not a complete re-write of the GAMAP IDL pacakage, 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. GCPy features several plotting and tabling functions, and also supports regridding GEOS-Chem NetCDF files between the grid formats used in GEOS-Chem Classic and GCHP.
  
The GEOS-Chem Support Team is presently working to update the GCPy documentation on readthedocs.io.  At present, the documentation is not complete, but will be updated as time allows.  GCPy also includes a few example scripts and notebooks that you can work through.
+
Full GCPy documentation is available [https://gcpy.readthedocs.io/en/latest/ on ReadTheDocs].
  
As of this writing (June 2019), most of the functions in GCPy are geared towards creating the evaluation plots for the [[GEOS-Chem Benchmarks|GEOS-Chem benchmark simulations]].  The [[GEOS-Chem Support Team]] will be adding new functionality to GCPy in the near future. If you have your own Python plotting or analysis code, and would like to make it a part of GCPy, please contact the Support Team.
+
The [[GEOS-Chem Support Team]] continues to add new features and functionality to GCPy. Details on contributing to GCPy can be found on the ReadTheDocs site.
  
 
== Third-party Python tools ==
 
== Third-party Python tools ==

Revision as of 18:50, 9 November 2020

Previous | Next | Getting Started with GEOS-Chem

  1. Minimum system requirements
  2. Configuring your computational environment
  3. Downloading source code
  4. Downloading data directories
  5. Creating run directories
  6. Configuring runs
  7. Compiling
  8. Running
  9. Output files
  10. Visualizing and processing output
  11. Coding and debugging
  12. Further reading


On this page, we provide information about free and open-source Python-language tools for visualizing or analyzing GEOS-Chem data.

GCPy

The GEOS-Chem Support Team develops GCPy, which is a Python-based toolkit containing useful functions and routines for working with GEOS-Chem. GCPy is meant to update and replace the IDL-based GAMAP utility. While not a complete re-write of the GAMAP IDL pacakage, 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. GCPy features several plotting and tabling functions, and also supports regridding GEOS-Chem NetCDF files between the grid formats used in GEOS-Chem Classic and GCHP.

Full GCPy documentation is available on ReadTheDocs.

The GEOS-Chem Support Team continues to add new features and functionality to GCPy. Details on contributing to GCPy can be found on the ReadTheDocs site.

Third-party Python tools

Several third-party Python packages have been developed for GEOS-Chem. If you are interested in using any of these, we recommend that you follow up with the developers directly. The GEOS-Chem Support Team is not responsible for maintaining these tools.

Developer Packages/Description Status
Jiawei Zhuang xESMF: A universal regridder. Leverages ESMF's regridding capabilities to easily regrid data between lon-lat and cubed-sphere grids. Other grids are supported as well. Available on Github
Daniel Rothenberg xbpch: Backend for reading bpch output into xarray/dask Available on Github
Barron Henderson Several software packages, including:
  1. PseudoNetCDF: a NetCDF like system including visualization (maps, profiles, timeseries, etc)
  2. Process analysis diagnostics: A tool for examining the change in each species due to each process and reaction.
Available on Github
Andre Perkins pyEnsemble: This code is useful for running ensembles of GEOS-Chem adjoint model simulations within an MPI environment. Available on Github

Core Python packages for Earth Science data

For the most part, you don't need to use a lot of Python packages to read and plot GEOS-Chem data. For example, the GCPy package mostly relies on the following packages, which can be downloaded with either PyPI and/or Conda.

  • xarray: For reading netCDF, HDF5, GRIB, etc. data into a common data structure for later manipulation
  • matplotlib: For general plotting operations
  • cartopy: For plotting data on world maps
  • numpy: For math operations
  • xESMF: For regrididdng between cubed-sphere to lat-lon grids
  • pandas: For spreadsheet-like data analysis

--Bob Yantosca (talk) 16:15, 14 June 2019 (UTC)

Python tutorials and resources

If you are new to Python, we strongly recommend that you take our GEOS-Chem Python Tutorial. It will walk you though the steps of creating sample plots from GEOS-Chem output:

You may also find these resources useful:

--Bob Yantosca (talk) 16:21, 14 June 2019 (UTC)



Previous | Next | Getting Started with GEOS-Chem