clean up imports in example docs

Author: haileyajohnson

.gitignore

@@ -9,4 +9,5 @@ uv.lock
 # build files
 **/*.egg-info
 **/__pycache__
-**/build
+**/build
+**/.ipynb_checkpoints/

cdippy/nchashes.py

@@ -3,19 +3,13 @@
 
 
 class NcHashes:
-    """
-    A class that checks for changes to datasets since by reading the online list of historic netCDF file hashes.
-    """
+    """Methods for working with the online list of historic nc file hashes."""
 
     hashes_url = "http://cdip.ucsd.edu/data_access/metadata/wavecdf_by_datemod.txt"
     new_hashes = {}
 
-    def __init__(self):
-        """
-        Args:
-            hash_file_location (str, optional): A path to the location to store the local copy of HASH.pkl. Defaults to the current directory.
-        """
-        self.load_hash_table()
+    def __init__(self, hash_file_location=""):
+        self.hash_pkl = hash_file_location + "/HASH.pkl"
 
     def load_hash_table(self):
         lines = url_utils.read_url(self.hashes_url).strip().split("\n")
@@ -27,14 +21,17 @@ def load_hash_table(self):
                 continue
             self.new_hashes[fields[0]] = fields[6]
 
-    def compare_hash_tables(self) -> list:
-        """
-        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.
+    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
 
-        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()
+    def compare_hash_tables(self) -> list:
+        """Return a list of nc files that have changed or are new."""
+        old_hashes = self.get_old_hashes()
         changed = []
         if old_hashes:
             if len(self.new_hashes) == 0:

cdippy/ndbc.py

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

cdippy/stndata.py

@@ -269,6 +269,7 @@ def get_series(
         self.force_64bands = force_64bands
 
         self.set_request_info(start, end, vrs, pub_set, apply_mask)
+        print(self.deploy_num)
 
         if prefix == "xyz" and self.deploy_num is None:
             return self.__merge_xyz_request()

docs/examples/cdippy-boxplot.ipynb

@@ -28,7 +28,23 @@
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "ename": "FileNotFoundError",
+     "evalue": "[Errno 2] No such file or directory: 'pyproject.toml'",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[31m---------------------------------------------------------------------------\u001b[39m",
+      "\u001b[31mFileNotFoundError\u001b[39m                         Traceback (most recent call last)",
+      "\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[1]\u001b[39m\u001b[32m, line 10\u001b[39m\n\u001b[32m      7\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcalendar\u001b[39;00m\n\u001b[32m      9\u001b[39m \u001b[38;5;66;03m# CDIP imports\u001b[39;00m\n\u001b[32m---> \u001b[39m\u001b[32m10\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\n\u001b[32m     11\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mstndata\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m StnData\n",
+      "\u001b[36mFile \u001b[39m\u001b[32m/opt/homebrew/Caskroom/miniconda/base/envs/cdippy/lib/python3.13/site-packages/cdippy/__init__.py:2\u001b[39m\n\u001b[32m      1\u001b[39m \u001b[38;5;66;03m# import public top-level modules\u001b[39;00m\n\u001b[32m----> \u001b[39m\u001b[32m2\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01m.\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m cdipnc, nchashes, ncstats, ndbc, plotting, spectra, stndata\n\u001b[32m      4\u001b[39m \u001b[38;5;66;03m# import plots library for backward compatibility\u001b[39;00m\n\u001b[32m      5\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01m.\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m plots \u001b[38;5;28;01mas\u001b[39;00m plots  \u001b[38;5;66;03m# noqa: F401\u001b[39;00m\n",
+      "\u001b[36mFile \u001b[39m\u001b[32m/opt/homebrew/Caskroom/miniconda/base/envs/cdippy/lib/python3.13/site-packages/cdippy/cdipnc.py:11\u001b[39m\n\u001b[32m      8\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mnumbers\u001b[39;00m\n\u001b[32m      9\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mbisect\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m bisect_left, bisect_right\n\u001b[32m---> \u001b[39m\u001b[32m11\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mndbc\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mndbc\u001b[39;00m\n\u001b[32m     12\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcu\u001b[39;00m\n\u001b[32m     13\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01murls\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01muu\u001b[39;00m\n",
+      "\u001b[36mFile \u001b[39m\u001b[32m/opt/homebrew/Caskroom/miniconda/base/envs/cdippy/lib/python3.13/site-packages/cdippy/ndbc.py:6\u001b[39m\n\u001b[32m      3\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mos\u001b[39;00m\n\u001b[32m      4\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mdatetime\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m datetime, timezone\n\u001b[32m----> \u001b[39m\u001b[32m6\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01murls\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01muu\u001b[39;00m\n\u001b[32m      7\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcdippy\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mutils\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mcu\u001b[39;00m\n\u001b[32m      9\u001b[39m sos_base = \u001b[33m\"\u001b[39m\u001b[33mhttps://sdf.ndbc.noaa.gov/sos/server.php\u001b[39m\u001b[33m\"\u001b[39m\n",
+      "\u001b[36mFile \u001b[39m\u001b[32m/opt/homebrew/Caskroom/miniconda/base/envs/cdippy/lib/python3.13/site-packages/cdippy/utils/urls.py:8\u001b[39m\n\u001b[32m      5\u001b[39m \u001b[38;5;28;01mfrom\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01murllib\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mimport\u001b[39;00m request, error\n\u001b[32m      6\u001b[39m \u001b[38;5;28;01mimport\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mxml\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01metree\u001b[39;00m\u001b[34;01m.\u001b[39;00m\u001b[34;01mElementTree\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[38;5;28;01mas\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34;01mET\u001b[39;00m\n\u001b[32m----> \u001b[39m\u001b[32m8\u001b[39m \u001b[38;5;28;01mwith\u001b[39;00m \u001b[38;5;28;43mopen\u001b[39;49m\u001b[43m(\u001b[49m\u001b[33;43m\"\u001b[39;49m\u001b[33;43mpyproject.toml\u001b[39;49m\u001b[33;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[33;43m\"\u001b[39;49m\u001b[33;43mrb\u001b[39;49m\u001b[33;43m\"\u001b[39;49m\u001b[43m)\u001b[49m \u001b[38;5;28;01mas\u001b[39;00m f:\n\u001b[32m      9\u001b[39m     pyproject = tomllib.load(f)\n\u001b[32m     11\u001b[39m version = pyproject[\u001b[33m\"\u001b[39m\u001b[33mproject\u001b[39m\u001b[33m\"\u001b[39m][\u001b[33m\"\u001b[39m\u001b[33mversion\u001b[39m\u001b[33m\"\u001b[39m]\n",
+      "\u001b[31mFileNotFoundError\u001b[39m: [Errno 2] No such file or directory: 'pyproject.toml'"
+     ]
+    }
+   ],
    "source": [
     "import netCDF4\n",
     "import numpy as np\n",
@@ -87,16 +103,20 @@
    "metadata": {},
    "outputs": [
     {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ASTORIA CANYON, OR BUOY - 179p1\n"
+     "ename": "NameError",
+     "evalue": "name 'StnData' is not defined",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[31m---------------------------------------------------------------------------\u001b[39m",
+      "\u001b[31mNameError\u001b[39m                                 Traceback (most recent call last)",
+      "\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[4]\u001b[39m\u001b[32m, line 2\u001b[39m\n\u001b[32m      1\u001b[39m \u001b[38;5;66;03m##- Get Station Dataset object\u001b[39;00m\n\u001b[32m----> \u001b[39m\u001b[32m2\u001b[39m stn_data = \u001b[43mStnData\u001b[49m(stn)\n\u001b[32m      4\u001b[39m \u001b[38;5;66;03m##- Get metadata (i.e. information about individual deployments)\u001b[39;00m\n\u001b[32m      5\u001b[39m meta = stn_data.get_stn_meta()\n",
+      "\u001b[31mNameError\u001b[39m: name 'StnData' is not defined"
      ]
     }
    ],
    "source": [
     "##- Get Station Dataset object\n",
-    "stn_data = cdippy.stndata.StnData(stn)\n",
+    "stn_data = StnData(stn)\n",
     "\n",
     "##- Get metadata (i.e. information about individual deployments)\n",
     "meta = stn_data.get_stn_meta()\n",
@@ -129,24 +149,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "dict_keys(['waveTime', 'waveDp', 'waveHs', 'waveTp'])"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "##- Use CDIPPY to convert input start/end date strings to datetime objects\n",
-    "start = cdippy.utils.cdip_datetime(sdate)\n",
-    "end = cdippy.utils.cdip_datetime(edate)\n",
+    "start = cdippy.utils.utils.cdip_datetime(sdate)\n",
+    "end = cdippy.utils.utils.cdip_datetime(edate)\n",
     "\n",
     "##- Grab default data using 'get_series' function, will mask out all non-public data\n",
     "data = stn_data.get_series(start, end, params)\n",
@@ -365,7 +374,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.2"
+   "version": "3.13.5"
   }
  },
  "nbformat": 4,