Welcome to the PyNimbus documentation!

PyNimbus is a Python package that aims to aid the process of obtaining select National Weather Service products and organizing the data of the product in a “ready to go” format. This “ready to go” format is designed to be able to be immediately integrated in any project/application that requires data analysis or visualization.

• Installation Guide
  • Installing with pip
  • Requirements
• SPC Storm Reports
  • Summary
  • Retrieving the reports
  • Working with parameters
    • Working with the link to retrieve a certain day
  • Plotting Using Cartopy
  • Save to CSV
  • Additional resources
• NHC Cyclones
  • Summary
  • Retrieving the data
  • Plotting Using Cartopy
  • Save to CSV
  • Additional resources

Here is a general overview of how PyNimbus works on both the user-end and on the “back-end”:

Note that PyNimbus follows a naming convention, which is (not explicitly) shown in the above chart. This naming convention is as such:

pynimbus.get_<NWS Branch>_<Product>(**kwargs, *args)

For example, if we wanted to get cyclone information from the National Hurricane Center:

pynimbus.get_nhc_previous_cyclone(**kwargs, *args)

Note that some of the functions listed above may not be in PyNimbus at the current moment. PyNimbus is still under development, but is useable in its current state.

Indices and tables

• Index
• Module Index
• Search Page