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.
If you wish to contribute to PyNimbus, please see the contributing file.
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 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 |
The easiest way to install is through pip: pip install pynimbus
PyNimbus falls under the BSD 3-Clause license. See the License page for more information.
v0.1.0 - Released 10/14/19
-
PyNimbus geometries have been built. PyNimbus geometries are the building block to be able to structure and organize lat/lon pairs for easy access.
-
get_nhc_past_cyclone_has been implemented. See the tutorial for usage