add option to view notebooks in the browser

haileyajohnson · haileyajohnson · commit a3e7c1cbfbef · 2025-09-15T15:12:23.000-07:00
provide option to view example notebooks in browser
diff --git a/cdippy/nchashes.py b/cdippy/nchashes.py
@@ -3,13 +3,19 @@
 
 
 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 = {}
 
-    def __init__(self, hash_file_location=""):
-        self.hash_pkl = hash_file_location + "/HASH.pkl"
+    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 load_hash_table(self):
         lines = url_utils.read_url(self.hashes_url).strip().split("\n")
@@ -21,17 +27,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:
diff --git a/cdippy/ndbc.py b/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
diff --git a/cdippy/plots/__init__.py b/cdippy/plots/__init__.py
@@ -1,3 +0,0 @@
-from . import annual_hs_boxplot, compendium, sst_climatology
-
-__all__ = ["annual_hs_boxplot", "compendium", "sst_climatology"]
diff --git a/docs/examples/cdippy-spectrum2d.ipynb b/docs/examples/cdippy-spectrum2d.ipynb
diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -11,10 +11,10 @@ Table below describes what can be found within each interactive notebook
 
 | Thumbnail | Title | Description | Notebook |
 |-----------|-------|-------------|----------|
-| ![compendium_thumb](thumbnails/cdippy-compendium.png) | **Compendium Plot** | Visualize common CDIP parameters over time | [`cdippy-compendium.ipynb`](cdippy-compendium.ipynb) |
-| ![sst_thumb](thumbnails/cdippy-sst.png) | **Sea Surface Temperature Plot** | Visualize CDIP SST over time | [`cdippy-sst.ipynb`](cdippy-sst.ipynb) |
-| ![boxplot_thumb](thumbnails/cdippy-boxplot.png) | **Wave Height Seasonal Boxplot** | Compute statistics and visualize CDIP wave heights | [`cdippy-boxplot.ipynb`](cdippy-boxplot.ipynb) |
-| ![xyz_thumb](thumbnails/cdippy-xyz.png) | **XYZ Displacements Plot** | Access and visualize CDIP xyz displacement data | [`cdippy-xyz.ipynb`](cdippy-xyz.ipynb) |
-| ![spectrum1d_thumb](thumbnails/cdippy-spectrum1d.png) | **Wave Spectrum 1D Plot** | Access and visualize CDIP 1-D wave spectra data | [`cdippy-spectrum1d.ipynb`](cdippy-spectrum1d.ipynb) |
-| ![spectrum2d_thumb](thumbnails/cdippy-spectrum2d.png) | **Wave Spectrum 2D Plot** | Access and visualize CDIP 2-D wave spectra data | [`cdippy-spectrum2d.ipynb`](cdippy-spectrum2d.ipynb) |
+| ![compendium_thumb](thumbnails/cdippy-compendium.png) | **Compendium Plot** | Visualize common CDIP parameters over time | [📖 View](cdippy-compendium.ipynb) <br> [⬇️ Download](cdippy-compendium.ipynb){:download} |
+| ![sst_thumb](thumbnails/cdippy-sst.png) | **Sea Surface Temperature Plot** | Visualize CDIP SST over time | [📖 View](cdippy-sst.ipynb) <br> [⬇️ Download](cdippy-sst.ipynb){:download} |
+| ![boxplot_thumb](thumbnails/cdippy-boxplot.png) | **Wave Height Seasonal Boxplot** | Compute statistics and visualize CDIP wave heights | [📖 View](cdippy-boxplot.ipynb) <br> [⬇️ Download](cdippy-boxplot.ipynb){:download} |
+| ![xyz_thumb](thumbnails/cdippy-xyz.png) | **XYZ Displacements Plot** | Access and visualize CDIP xyz displacement data | [📖 View](cdippy-xyz.ipynb) <br> [⬇️ Download](cdippy-xyz.ipynb){:download} |
+| ![spectrum1d_thumb](thumbnails/cdippy-spectrum1d.png) | **Wave Spectrum 1D Plot** | Access and visualize CDIP 1-D wave spectra data | [📖 View](cdippy-spectrum1d.ipynb) <br> [⬇️ Download](cdippy-spectrum1d.ipynb){:download} |
+| ![spectrum2d_thumb](thumbnails/cdippy-spectrum2d.png) | **Wave Spectrum 2D Plot** | Access and visualize CDIP 2-D wave spectra data | [📖 View](cdippy-spectrum2d.ipynb) <br> [⬇️ Download](cdippy-spectrum2d.ipynb){:download} |
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,8 +1,15 @@
 site_name: CDIPpy Docs
 
+# theme:
+#   name: material
+
+markdown_extensions:
+  - attr_list
+
 plugins:
   - macros
   - search
+  - mkdocs-jupyter
   - mkdocstrings:
       handlers:
         python:
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,7 +34,9 @@ dev = [
     "coverage",
     "flake8",
     "mkdocs",
+    "mkdocs-jupyter",
     "mkdocs-macros-plugin",
+    "mkdocs-material",
     "mkdocstrings[python]",
     "mkdocs-material",
     "mkdocstrings[python]",

Original file line number	Diff line number	Diff line change
`@@ -1,3 +0,0 @@`
`1`		`-from . import annual_hs_boxplot, compendium, sst_climatology`
`2`		`-`
`3`		`-__all__ = ["annual_hs_boxplot", "compendium", "sst_climatology"]`