sharppy.sharptab package
========================

Submodules
----------

Modules that perform data analysis and processing tasks in SHARPpy.  

sharppy.sharptab.constants module
---------------------------------

Contains constants used by the SHARPpy routines.

.. automodule:: sharppy.sharptab.constants
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.fire module
----------------------------

Contains routines that analyze the potential for fire weather using
sounding profiles.

.. automodule:: sharppy.sharptab.fire
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.interp module
------------------------------

Contains routines that use the numpy interpolation routines to interpolate
various variables in the sounding data.  

.. automodule:: sharppy.sharptab.interp
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.params module
------------------------------

Contains a wide variety of routines that calculate convection indices.  

.. automodule:: sharppy.sharptab.params
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.prof\_collection module
----------------------------------------

Code that describes the "Profile Collection" objects that is used by the 
sharppy.io.decoders and the SHARPpy GUI.  This is essentially an object that
is a collection of Profile objects.

.. _sharppy.sharptab.prof_collection:

.. automodule:: sharppy.sharptab.prof_collection
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.profile module
-------------------------------

Contains code to create the Profile objects.

.. automodule:: sharppy.sharptab.profile
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.thermo module
------------------------------

Contains code to perform thermodynamic routines (i.e. saturated lifting,
dry lifting, calculation of dewpoint, mixing ratio, equivalent potential temperature)

.. automodule:: sharppy.sharptab.thermo
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.utils module
-----------------------------

Contains helper functions to convert data types.

.. automodule:: sharppy.sharptab.utils
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.watch\_type module
-----------------------------------

Contains functions to calculate the possible hazard type
and precipitation type values (for the Winter inset).

.. automodule:: sharppy.sharptab.watch_type
    :members:
    :undoc-members:
    :show-inheritance:

sharppy.sharptab.winds module
-----------------------------

Contains functions to analyze the wind data of Profile objects.  Contains
routines to calculate wind shear, pressure-weighted mean winds, storm-relative
helicity, and critical angle.

.. automodule:: sharppy.sharptab.winds
    :members:
    :undoc-members:
    :show-inheritance:


Module contents
---------------

.. automodule:: sharppy.sharptab
    :members:
    :undoc-members:
    :show-inheritance: