.. MHKiT Documentation

.. figure:: figures/MHKiT_logo.png
   :target: https://github.com/MHKiT-Software
   :scale: 50 %
   :alt: MHKiT logo


.. toctree::
   :maxdepth: 4
   :hidden:

   overview.rst
   terminology.rst
   installation.rst
   qc.rst
   wave.rst
   river.rst
   tidal.rst
   power.rst
   loads.rst
   dolfyn.rst
   mooring.rst
   utils.rst
   python.rst
   matlab.rst
   troubleshooting.rst
   webinars.rst
   license.rst
   release_notes.rst
   citeus.rst
   contact.rst






######################################################
MHKiT (Marine and Hydrokinetic Toolkit)
######################################################
MHKiT is open-source marine renewable energy (MRE) software, developed in Python and MATLAB, that includes modules for ingesting, quality controlling, processing, visualizing, and managing data.
`MHKiT-Python <https://github.com/MHKiT-Software/MHKiT-Python>`_ and `MHKiT-MATLAB <https://github.com/MHKiT-Software/MHKiT-MATLAB>`_  provide robust and verified functions in both Python and MATLAB that are needed by the MRE community to standardize data processing. Calculations and visualizations adhere to International Electrotechnical Commission (IEC) technical specifications and other guidelines. Current functionality includes power performance, power quality, mechanical loads, resource tools, and data quality control for wave, tidal, and river applications.

|python_image|   |matlab_image|

.. |python_image| image:: figures/python-logo-master-v3-TM.png
   :target: https://www.python.org/
   :width: 45%
   :alt: Python logo

.. |matlab_image| image:: figures/mathworks-logo-full-color-rgb.png
   :target: https://www.mathworks.com/
   :width: 45%
   :alt: Matlab logo

Developers
================
MHKiT is developed as a collaboration between the National Renewable Energy Laboratory (NREL), Pacific Northwest National Laboratory (PNNL), and Sandia National Laboratories (Sandia, SNL). 

Current members of the core development team include:

- Rebecca Fao (NREL - PI)
- Sterling Olson (Sandia)
- James McVey (PNNL)
- Hristo Ivanov (NREL)
- Carlos Michelen (Sandia)
- Emily Browning (Sandia)
- Adam Keester (Sandia)
- Cesar Castillo (Sandia)
- Budi Gunawan (Sandia - PI)

Former members of the core development team include:

- Matthew Boyd (NREL)
- Alex McVey (NREL)
- Katherine Klise (Sandia)
- Kelley Ruehl (Sandia)
- Frederick Driscoll (NREL)


.. Note: here we could call out specific external (or lab-internal) staff that have contributed significantly

MHKiT has had many additional contributors. An extensive list of contributors can be found on the
`MHKiT-Python Contributors <https://github.com/MHKiT-Software/MHKiT-Python/graphs/contributors>`_ page and the
`MHKiT-MATLAB Contributors <https://github.com/MHKiT-Software/MHKiT-MATLAB/graphs/contributors>`_ page.


Funding
================
The development of MHKiT is funded by the U.S. Department of Energy's Water Power Technologies Office.
The copyright of MHKiT is held by the National Renewable Energy Laboratory,
Pacific Northwest National Laboratory, and Sandia National Laboratories.
The software is distributed under the :ref:`License:Revised BSD License`.

The `National Renewable Energy Laboratory <https://www.nrel.gov/>`_ is a national laboratory of the U.S. Department of Energy, Office of Energy Efficiency and Renewable Energy, operated by the Alliance for Sustainable Energy, LLC. under contract No. DE-AC36-08GO28308.

`Pacific Northwest National Laboratory <https://www.pnnl.gov/>`_ is operated by Battelle for the United States Department of Energy under Contract DE-AC05-76RL01830.

`Sandia National Laboratories <http://www.sandia.gov/>`_ is a multi-mission laboratory managed and operated by National Technology
and Engineering Solutions of Sandia, LLC., a wholly-owned subsidiary of Honeywell International, Inc., for the U.S. Department of Energy's National
Nuclear Security Administration under contract DE-NA0003525.

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

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