.. EMCPy documentation master file, created by
   sphinx-quickstart on Thu May 18 19:19:12 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

EMCPy
=================================

.. toctree::
    :hidden:

    getting_started/index
    plot_types/index
    examples/index
    installing


Introduction
============

EMCPy is a collection of Python tools and utilities developed within EMC. The vision for EMCPy was to develop a centralized repository to create a Python "toolkit" for both experienced and novice users.

The ultimate goal is to create these collection of tools into a Python package. The code leverages Object Oriented Programming (OOP), agile development, and includes thorough documentation for future developers.

This code has been made freely available under the terms of the
`GNU Lesser General Public License <https://www.gnu.org/licenses/lgpl.html>`_.


Contributing
============

There are several different ways to help contribute to EMCPy:

 * Report bugs and problems with the code or documentation to https://github.com/NOAA-EMC/emcpy/issues.
 * Contribute to the documentation fixing typos, adding examples, or explaining things more clearly.
 * Contribute bug fixes (`a list of outstanding bugs can be found on GitHub <https://github.com/NOAA-EMC/emcpy/issues>`_).
 * Add new features by opening a pull request.

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

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