Merge branch 'main' into examples

Author: haileyajohnson

cdippy/nchashes.py

@@ -3,7 +3,9 @@
 
 
 class NcHashes:
-    """Methods for working with the online list of historic nc file hashes."""
+    """
+    A class that checks for changes to datasets since by reading the online list of historic netCDF file hashes.
+    """
 
     hashes_url = "http://cdip.ucsd.edu/data_access/metadata/wavecdf_by_datemod.txt"
     new_hashes = {}
@@ -21,17 +23,14 @@ def load_hash_table(self):
                 continue
             self.new_hashes[fields[0]] = fields[6]
 
-    def get_last_deployment(self, stn: str) -> str:
-        """Returns the last deployment string, e.g. 'd03'."""
-        last_deployment = "d00"
-        for name in self.new_hashes:
-            if name[0:5] == stn and name[5:7] == "_d" and last_deployment < name[6:9]:
-                last_deployment = name[6:9]
-        return last_deployment
-
     def compare_hash_tables(self) -> list:
-        """Return a list of nc files that have changed or are new."""
-        old_hashes = self.get_old_hashes()
+        """
+        Compare the current in-memory list of files, loaded by `load_hash_table` to the list saved in HASH.pkl and return a list of stations that are new or have changed.
+
+        Returns:
+            changed ([str]): A list of nc files that have changed or are since HASH.pkl was last saved.
+        """
+        old_hashes = self._get_old_hashes()
         changed = []
         if old_hashes:
             if len(self.new_hashes) == 0:
@@ -46,5 +45,5 @@ def compare_hash_tables(self) -> list:
     def save_new_hashes(self):
         cdip_utils.pkl_dump(self.new_hashes, self.hash_pkl)
 
-    def get_old_hashes(self):
+    def _get_old_hashes(self):
         return cdip_utils.pkl_load(self.hash_pkl)

cdippy/ndbc.py

@@ -45,5 +45,4 @@ def get_wmo_id(
         ids = cdip_utils.pkl_load(pkl_fl)
     if stn in ids:
         return ids[stn]
-    else:
-        return None
+    return None