Skip to content

NWS Lookup Tables

Summary

This MR adds functionality for building lookup tables for collaboration with the NWS.

Details

  • Added the authenticate nws command for saving NWS FTP credentials
  • In configuration.py, added the nws_min, nws_max, and nws_step fields
  • Added validation of the aforementioned nws fields
  • The run command now builds debris-flow probability lookup tables and saves them as nws-tables.zip
  • Added the upload nws command for uploading lookup tables to the NWS FTP endpoint

Where to review

As usual, you can find the complete list of changes in the "changes" tab of the MR. But the following summarizes the major points:

Code

  • In ocelote/_commands/authenticate.py: Added a big block in the _platform function with all the text used to collect nws authentication credentials
  • In ocelote/_commands/run: Added the _nws.py module, which computes and saves the lookup tables
  • In ocelote/_commands/upload: Added the _nws.py module, which uploads the lookup tables to the FTP endpoint

Docs (These are all in the ocelote user guide, or the Resources sections)

  • In Overview: Added the authenticate/upload nws commands to the table
  • In Installation: Added the section on authenticating with NWS
  • In Quickstart: Added a paragraph to the "Run" section describing the produced lookup tables. Also added the "Upload to NWS" section (at the end)
  • In API/Configuration Files/configuration.py: Added the section on NWS lookup tables
  • In API/Commmand Line: Added the "authenticate nws" and "upload nws" sections. Also added a description of the lookup tables in "run"
  • In API/Python/Functions: Added the "authenticate nws" and "upload nws" sections. Also added a description of the lookup tables in "run"
  • In Resources/Citation: Updated citation info for ocelote 1.1.0
  • In Resources/Release Notes: Added release notes for ocelote 1.1.0

You can preview the updated docs here: Updated Docs

Closes #6 (closed) , #7 (closed)

Edited by King, Jonathan M

Merge request reports

Loading