Skip to content

Commit

Permalink
paper.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kylejgillett committed Jan 13, 2025
1 parent a5c457c commit e42d1b5
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions joss-paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,28 @@ SounderPy addresses these challenges by providing simple access to multiple data
including National Weather Service radiosonde observations (RAOBs), Aircraft Communications
Addressing and Reporting System (ACARS) data, NWP forecast data, and reanalysis datasets.
Each of these data types come from unique file formats and structures, which SounderPy
processes to normalize and streamline analysis and visualization of soundings.
processes to normalize and streamline analysis and visualization of soundings. After requesting
data, SounderPy will process and output the data as a Python dictionary, coined a "SounderPy
`clean_data` dictionary". Doing so means that every data source ends up in a uniform format for
analysis.


# High-level API overview

Simple, intuitive classes and functions make SounderPy's API easy to understand and
use. The procedure for creating sounding figures requires only a few lines of
straightforward API calls that first retrieve data from a source and plot the data
on a figure. While internally this involves sophisticated data retrieval and processing
methods, extensive manipulations and calculations, and intricate plotting routines, the
user-facing interface allows this process to be completed in just two lines of code for
most integrated data sources. The simplicity of these "tools" in SounderPy's "toolbox"
allows quick and easy use for researchers, students, and hobbyists alike. After importing
the library, two lines of code create Figure 1.
straightforward API calls that first retrieve data from a source, output the `clean_data`
dictionary and plot the data on a figure. While internally this involves sophisticated
data retrieval and processing methods, extensive manipulations and calculations, and
intricate plotting routines, the user-facing interface allows this process to be completed
in just two lines of code for most integrated data sources. The simplicity of these "tools"
in SounderPy's "toolbox"allows quick and easy use for researchers, students, and hobbyists
alike. After importing the library, two lines of code create Figure 1. On top of the many
integrated data sources, SounderPy also allows users to utilize their own custom data. So
long as a user's custom data can be manually sorted into a `clean_data` dictionary, it can
be used with SounderPy's analysis and plotting functionality.




![Figure 1: A sounding figure of NCEP RAP reanalysis data for a severe weather event in northern South Dakota on August 28th, 2024](figure_1.jpg)
Expand All @@ -77,4 +85,6 @@ Amelia R.H. Urquhart (University of Oklahoma), Ryan Vandersmith, and many others

This project also extends its graditude to the researchers, institutions, and
individuals who have utilized SounderPy in their work and publications, driving
its growth and application within the meteorological community.
its growth and application within the meteorological community.

# References

0 comments on commit e42d1b5

Please sign in to comment.