###################################
Welcome to PyGNOME's documentation!
###################################

PyGNOME is general Lagrangian Element (particle tracking) code written primarily in Python, with some bindings to C++ code for certain functionality. It is the core engine of the General NOAA Operational Modeling Environment (GNOME) Suite of tools.

This document provides guidance on using the PyGNOME package to solve problems, as well as details about its internals that can be used to extend PyGNOME's functionality.

The PyGNOME source code can be found on GitHub Here:

https://github.com/NOAA-ORR-ERD/PyGnome

And this document should be published here:

https://gnome.orr.noaa.gov/doc/pygnome/index.html


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   introduction
   installing
   structure
   scripting/index
   extending/index
   file_formats/index
   autoapi/index
   units
   tech_notes


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

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