isabella232 / geocat-examples

CI
Docs
License
Citing

GeoCAT-examples

GeoCAT-examples repo contains visualization examples that demonstrate how to use GeoCAT’s computational functions or how to plot data with packages in the Python ecosystem (primarily, Matplotlib and Cartopy).

Check out our GeoCAT-Examples Gallery to see the example plots and to access Python code files as well as auto-generated Jupyter notebooks of this repo!

Several visualizations in this repository could be compared to NCL scripts from the NCL Application Examples website.

A primary objective of this project is to identify any NCL plotting functionality that is missing from the popular Matplotlib + Cartopy toolchain, so each contributed script, if originating from NCL, should contain a best-effort attempt at reproducing an NCL graphic as closely as possible without using NCL or PyNGL. In the future, PyNGL examples may be included in this repository as well, but the current goal is to see what can't be done with Matplotlib and Cartopy.

That said, if you identify any NCL functionality in particular that does not seem to exist in Matplotlib/Cartopy, please create an issue on this repository's GitHub page with a link to the original NCL example page and list any NCL functions whose functionality is missing from Python.

As a secondary objective, this repository may also contain extended examples of the GeoCAT computational functions (GeoCAT-comp), which may be too long/complex to be included in the function's doc string and/or requires visualization for improved demonstration.

Documentation

GeoCAT Homepage

GeoCAT Contributor's Guide

GeoCAT-Examples Gallery

NCL Application Examples

Installation instructions

Please see our documentation for installation instructions.

Citing GeoCAT-examples

If you use this software, please cite it as described at the GeoCAT-examples - Citation page.