.. pyugrid documentation master file, created by
   sphinx-quickstart on Wed Jan  7 13:56:06 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyugrid's documentation!
===================================

Currently, this only contains reference docs -- auto-generated from the source docstrings.

One of these days, we'll add more/better docs -- contributions welcome!

For some examples of use, see Jupyter notebooks found in ``notebook_examples`` in the source.


Contents:

.. toctree::
   :maxdepth: 2


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Reference
=========

.. automodule:: pyugrid
    :members:
    :undoc-members:

----------

.. automodule:: pyugrid.read_netcdf
    :members:
    :undoc-members:

----------

.. automodule:: pyugrid.grid_io
    :members:
    :undoc-members: