Skip to main content

A Python package to organize National Weather Service product data.

Project description

PyNimbus

Documentation Status License Issues Version

PyNimbus's goal is to take the "middle man" out of downloading and sorting data found from various National Weather Service products such as NHC and SPC outlooks.

PyNimbus follows the semantic version numbering system.

Contributing to PyNimbus

If you wish to contribute to PyNimbus, please see the contributing file.

Asking questions about PyNimbus

If you have questions on how to use PyNimbus, please send me an email. The email can be found in the contributing file above. Please do not open an issue or pull request for questions regarding the usage of PyNimbus.

PyNimbus Function Naming Convention

PyNimbus follows a fairly straight-forward naming convention as such: get_<NWS BRANCH>_<PRODUCT>. The function returns an object with various attributes such as its associated pandas data frame or polygon.

If you are unfamiliar with the various National Weather Service branches, it is worth noting the following abbreviations:

Below is a table with the current functionality. See the documentation for more information regarding these.

Branch Product Attributes Function Call Tutorial Link
SPC Storm Reports .df, .points get_spc_storm_reports() Link
NHC Hurricane GIS .polygon, .line, .points get_nhc_previous_cyclone() Link

Installing PyNimbus

The easiest way to install is through pip: pip install pynimbus

License

PyNimbus falls under the BSD 3-Clause license. See the License page for more information.

Important Links

Version Log

v0.1.0 - Released 10/14/19

  1. PyNimbus geometries have been built. PyNimbus geometries are the building block to be able to structure and organize lat/lon pairs for easy access.

  2. get_nhc_past_cyclone is now here! Check out the tutorial in the PyNimbus documentation to see more about how you can use Cartopy to plot National Hurricane Center outlooks with a few lines of code!

  3. PyNimbus Geometries! In essence, you can think of these as an encapsulation (and implementation) of Shapely geometries. These geometries are the foundation of all polygons, lines, and points used within PyNimbus. All geometries consist of other geometries down to a point (lat/lon pair). This is going to be needed going into the future.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyNimbus-0.1.0.tar.gz (14.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page