Add documentation to ush/HWP_tools.py

docs/requirements.txt

@@ -1,3 +1,8 @@
 sphinxcontrib-bibtex
 sphinx_rtd_theme
-docutils==0.16
+docutils==0.16
+numpy
+xarray
+matplotlib
+netCDF4
+matplotlib

ush/HWP_tools.py

@@ -1,3 +1,8 @@
+"""
+This file provides Hourly Wildfire Potential (HWP) tools.
+
+"""
+
 import numpy as np
 import os
 import datetime as dt
@@ -7,6 +12,14 @@
 import fnmatch
 
 def check_restart_files(hourly_hwpdir, fcst_dates):
+    """Check the restart files.
+
+    Args:
+         hourly_hwpdir: the directory where the RESTART data is copied (nwges/HOURLY_HWP)
+         fcst_dates: Forecast dates
+    Returns:
+         list of hwp_avail_hours, hwp_non_avail_hours
+    """
     hwp_avail_hours = []
     hwp_non_avail_hours = []
 
@@ -25,6 +38,22 @@ def check_restart_files(hourly_hwpdir, fcst_dates):
     return(hwp_avail_hours, hwp_non_avail_hours)
 
 def copy_missing_restart(nwges_dir, hwp_non_avail_hours, hourly_hwpdir):
+    """Check the restart files.
+
+    Args:
+         nwges_dir: holds the boundary, INPUT, and RESTART files (e.g,
+         described here:
+         [ufs-community/ufs-srweather-app#654](https://github.com/ufs-community/ufs-srweather-app/issues/654))
+         The use of NWGES is a bit of a legacy variable name in
+         production. It is often used to define a directory holding
+         DA-relevant files (such as first guess and analysis files)
+         outside of the main COM output directory.
+         hwp_non_avail_hours: a list of hours without available RESTART files
+         hourly_hwpdir: ???
+    Returns:
+         list of (restart_avail_hours, restart_nonavail_hours_test)
+
+    """
     restart_avail_hours = []
     restart_nonavail_hours_test = []
 
@@ -79,6 +108,18 @@ def copy_missing_restart(nwges_dir, hwp_non_avail_hours, hourly_hwpdir):
     return(restart_avail_hours, restart_nonavail_hours_test)
 
 def process_hwp(fcst_dates, hourly_hwpdir, cols, rows, intp_dir, rave_to_intp):
+    """Check the restart files.
+
+    Args:
+         fcst_dates: Forecast dates
+         hourly_hwpdir: ???
+         cols: number of columns
+         rows: number of rowa
+         intp_dir: directory
+         rave_to_intp: ???
+    Returns:
+         list of (hwp_ave_arr, xarr_hwp, totprcp_ave_arr, xarr_totprcp)
+    """
     hwp_ave = [] 
     totprcp = np.zeros((cols*rows))
     var1, var2 = 'rrfs_hwp_ave', 'totprcp_ave'