.. _utils_api:

Utils Module
^^^^^^^^^^^^^^^^^^^^^^^^^^

The utils module includes helper functions. The module currently contains a single function to help users 
convert numeric indexes to datetime indexes.  Additional helper functions could be added at a later date.

    
.. autosummary::
   :nosignatures:

   ~mhkit.utils.get_statistics
   ~mhkit.utils.unwrap_vector
   ~mhkit.utils.matlab_to_datetime
   ~mhkit.utils.excel_to_datetime
   ~mhkit.utils.index_to_datetime
   
.. automodule:: mhkit.utils
    :members:
    :no-undoc-members:
    :show-inheritance:
    
    
.. autofunction:: mhkit.utils.index_to_datetime