Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kylejgillett authored Aug 24, 2023
1 parent d62914f commit 9666bb4
Showing 1 changed file with 20 additions and 34 deletions.
54 changes: 20 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,33 @@

# Modern-Sounding-Plotter
A Jupyter Notebook that creates a modern way to visualize sounding data for the purpose of environmental analysis.



## HEADS UP:
#### This script was written before the latest release of NumPy, and therefore a majority of this script will fail due to NumPy syntax errors within SharpPy functionality (as of early 2023).
#### I am in the process of writing a new updated version of this code using MetPy functions rather than SharpPy (as of 8/2023)
<div align='center'>

# Complex-Sounding-Viewer
### A Jupyter Notebook that creates a modern way to visualize sounding data for the purpose of environmental analysis.
#### This script was written by Kyle J Gillett (@wxkylegillett) (2023)

</div>

-----



This script was written by Kyle Gillett (@wxkylegillett) (2022)

The task of this script is to retrieve RAOB data, preform a number of calculations, and plot the data
on a Skew-T & hodograph.
The task of this script is to retrieve RAOB data using the SounderPy module ([Visit SounderPy on GitHub Here](https://github.com/kylejgillett/sounderpy/wiki)), perform a number of MetPy calculations, and plot the data on a Skew-T & hodograph.


The purpose of this script is to provide a modern, clean, clear, and concise sounding plot that makes
for quick and easy assessment of the data for environmental analysis purposes, focused on severe weather.

It should be noted that, as with any sounding plot, many of the calculations & plotting operations here
shoulder heavy assumptions, and these assumptions should be well understood to get the most out of any
sounding plot.
The purpose of this script is to provide a modern, clean, clear, and concise-sounding plot that makes for quick and easy assessment of the data for environmental analysis purposes, focused on severe weather.

Numerous python libraries are utilized throughout this script, including MetPy and SharpPy's python packages.
Several packages here may need to be installed onto your machine to run this code.
It should be noted that, as with any sounding plot, many of the calculations & plotting operations here shoulder heavy assumptions, and these assumptions should be well understood to get the most out of any sounding plot.

If you happen to run into any bugs, have questions or ideas, please message me on Twitter (@wxkylegillett)
or open an issue on GitHub.
Numerous Python libraries are utilized throughout this script, including metpy, ecape, sounderpy & matplotlib Python packages. Several packages here may need to be installed onto your machine to run this code.

- MAP INSET -
You will be able to plot tornado tracks and storm reports from the SPC on a small map inset on the sounding.
Please note: tornado tracks as of 12/22 are only, available between 1950 and 2021. If you are plotting a date
in 2022 or 2023 - turn off plot_TorTracks. SPC Storm Reports should be availible now through June 1st, 1999.
Missing or bad data is possible.

You can turn on reports or tracks by setting plot_TorTracks, plot_TorReports, plot_WindReports, & plot_HailReports equal,
to True, or off by setting them to False.

If you happen to run into any bugs, or have questions or ideas, please message me on Twitter (@wxkylegillett) or open an issue on GitHub.

<div align='center'>

## EXAMPLE PLOT

EXAMPLE PLOT
<img src="https://raw.githubusercontent.com/kylejgillett/Complex-Sounding-Viewer/main/complex-sounding-viewer-example.png">

![githubreleasetest4](https://user-images.githubusercontent.com/100786530/210025600-a778f8c9-8770-4487-afca-836d3146a070.png)
</div>

0 comments on commit 9666bb4

Please sign in to comment.