pygridgen

A Python interface to Pavel Sakov’s gridgen library

The full documentation for this for library is here.

For more detailed documentation on grid generation, manipulation, and visualization, see the documentation for pygridtools.

Credits

This fork of pygridgen stands on the very tall shoulders of Robert Hetland of Texas A&M University. Many thanks to him, Richard Signell, Filipe Fernandes, and all of the other contributors.

Dependencies

C Libraries

The following dependencies are all available via conda-forge for Linux and Mac OS:

• nn feedstock
• csa feedstock
• gridgen feedstock
• gridutils feedstock

Python

Provided that all of the shared C libraries are installed, the remaining python depedencies are the following:

• numpy
• matplotlib
• pyproj (only if working with geographic coordinates)

Testing

Tests are written using the pytest package. From the source tree, run them simply with by invoking pytest in a terminal. If you’re editing the source code, it helps to have pytest-pep8 installed to check code style.

Alternatively, from the source tree you can run python check_pygridgen.py --strict to run the units tests, style checker, and doctests.

Documentation

Building the HTML documentation requires:

• sphinx
• sphinx_rtd_theme
• numpydoc
• jupyter-notebook
• nbsphinx
• pandas
• seaborn

Installation

• Installation via conda
• Linux: Building from source
• Mac OS X: building from source

Tutorials

• Basic grid generation
  • Side channels: using \(\beta = -1\)
  • Using focus
  • More on the upper left index parameter
• Examples from the gridgen-c library
  • Sensitivity to \(\beta\)
  • Basic Estuary
  • These are just weird

API Reference

• The pygridgen API
• The csa API

Indices and tables

• Index
• Module Index
• Search Page