# PyCEM Gridtools
Python package that interfaces to various grid generation/interpolation tools and provides suitable parameter file inputs for SHOC/COMPAS models in EMS

### Contents
The Python package **cem_gridtools** contains the following modules:
* **gridgen** low-level interface to gridgen-c
* **grid_interp** low-level interface to the EMS grid library
* **cem_gridtools** module - this is the main high-level API

### To clone repository
`git clone --recurse-submodules https://bitbucket.csiro.au/scm/cem/pycem-gridtools.git`

### Pre-requisites/dependencies
* Linux environment
* Recent Python 3.6+ and numpy dev environments
	* Note: you may use **conda** to avoid system level installs of some packages (eg. python-dev)
* C compiler

Then all the python requirements are installed via `pip`

### Documentation
See [full documentation on the CEM site](http://cem.csiro.au/docs/pycem-gridtools)

### References and acknowledgements
* [gridgen-c](https://github.com/sakov/gridgen-c) - Pavel Sakov's code repository (imported as a submodule here)
* [pygridgen](https://github.com/hetland/pygridgen) - Another Python interface to **gridgen-c**, some of whose ideas are used here
* [NCAR PyNGL](https://www.pyngl.ucar.edu/Functions/Ngl.natgrid.shtml) - Sibson Natural Neighbours interpolation
* [EMS](https://github.com/csiro-coasts/EMS) - The CSIRO Environment Modelling Suite