.. SounderPy documentation master file, created by
   sphinx-quickstart on Thu Dec  7 19:10:38 2023.

🎈 SounderPy
=============

.. image:: _static/images/example-sounding_light.png
   :width: 300 px
   :align: left

SounderPy is an open-source atmospheric science Python package for vertical profile analysis. This tool is designed to get data, ‘clean it up’ for simple use, and plot the data on advanced-sounding plots. SounderPy was developed with the goal in mind to keep the code simple and efficient for users of all experience levels and for reliability in all use cases.

SounderPy is supported for Python >= 3.9. Examples of SounderPy use are available on the :doc:`examplescripts` page

.. image:: https://img.shields.io/pypi/v/sounderpy.svg
   :target: https://pypi.python.org/pypi/sounderpy/
   :alt: PyPI Package

.. image:: https://img.shields.io/pypi/dm/sounderpy.svg
   :target: https://pypi.python.org/pypi/sounderpy/
   :alt: PyPI Downloads

.. image:: https://img.shields.io/pypi/l/ansicolortags.svg
   :target: https://github.com/kylejgillett/sounderpy/blob/main/LICENSE.txt
   :alt: PyPI License

.. image:: https://img.shields.io/pypi/pyversions/sounderpy.svg
   :target: https://pypi.python.org/pypi/sounderpy/
   :alt: PyPI Python Versions

.. image:: https://badgen.net/github/commits/kylejgillett/sounderpy
   :target: https://GitHub.com/kylejgillett/sounderpy/commit/
   :alt: GitHub Commits

.. image:: https://img.shields.io/badge/maintainer-kylejgillett-blue
   :target: https://github.com/kylejgillett
   :alt: Maintainer

.. image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
   :target: https://www.python.org/
   :alt: Made with Python



Why SounderPy?
---------------

	* Sometimes data is tough to find, and often times it's even tougher to get it in the format you like. SounderPy gets you this data!
	* The code needed for loading and parsing meteorological data, especially from models, can be large and messy. SounderPy keeps it hidden away in a PyPi package -- just import and call sounderPy functions to keep your code clean!
	* SounderPy functions are designed to be simple and quick making for reliable use in research, forecast/analysis operations, and simply for fun!


What exactly can SounderPy do?
------------------------------

	* Retrieves vertical profile data 
	* 'Cleans up' the data for analysis 
	* Plots the data on advanced but easy to read sounding and hodograph plots. 
		+ See what kind of plots SounderPy can create :ref:`here<gallery>`




What data can SounderPy work with?
-----------------------------------

+--------------------------------+-----------------------+------------------+------------------+
|         **DATA**               |   **FUNCTION**        |  **TYPE**        |  **TIME RANGE**  |
+================================+=======================+==================+==================+
|    ECMWF CDS ERA5 reanalysis*  | get_model_data()      | Reanalysis       |  1940-present    |
+--------------------------------+-----------------------+------------------+------------------+
|     UNIDATA THREDDS TDS RAP    | get_model_data()      | Reanalysis       |  2005-present    |
+--------------------------------+-----------------------+------------------+------------------+
|     UNIDATA THREDDS TDS RUC    | get_model_data()      | Reanalysis       |  2005-2020       |
+--------------------------------+-----------------------+------------------+------------------+
|    UNIDATA THREDDS NCEP-FNL    | get_model_data()      | Reanalysis       |  2005-2020       |
+--------------------------------+-----------------------+------------------+------------------+
|    ISU's BUFKIT archive        | get_bufkit_data()     | Model Forecast   |  2011-present    |
+--------------------------------+-----------------------+------------------+------------------+
|     PSU's BUFKIT feed          | get_bufkit_data()     | Model Forecast   | Most recent runs |
+--------------------------------+-----------------------+------------------+------------------+
|  UNIDATA THREDDS TDS RAP       | get_model_data()      | Model Analysis   | Most recent run  |
+--------------------------------+-----------------------+------------------+------------------+
|   OU ACARS Archive             | acars_data()          | Observations     | 2019-present     |
+--------------------------------+-----------------------+------------------+------------------+
|  The Unv. of WY RAOB Archive   | get_obs_data()        | Observations     | 1973-present     |
+--------------------------------+-----------------------+------------------+------------------+
|  IGRAv2 Observation Archive    | get_obs_data()        | Observations     |  1905-present    |
+--------------------------------+-----------------------+------------------+------------------+
|  NWS NEXRAD AWS Archive        | pyart_radar_profile() | Observations     |  1990s-present   |
+--------------------------------+-----------------------+------------------+------------------+

      


☕ SounderPy is a open-source package developed on my own time. Would you like to support continued SounderPy development? Consider "`Buying me a coffee <https://www.buymeacoffee.com/kylejgillett>`_"! ☕

Directory
==================
  .. toctree::
     :maxdepth: 5
     :caption: General:
     
     about
     troubleshooting

  .. toctree::
     :maxdepth: 5
     :caption: API Reference:
   
     gettingdata 
     plottingdata
     helpertools

  .. toctree::
     :maxdepth: 5
     :caption: Tutorials:  

     examplegallery
     examplescripts


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

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