create a top-level plotting interface to replace the plots lib; clean up API refs for plotting

Author: haileyajohnson

cdippy/__init__.py

@@ -1,8 +1,5 @@
-# import plots library
-from . import plots
-
 # import public top-level modules
-from . import cdipnc, nchashes, ncstats, ndbc, spectra, stndata
+from . import cdipnc, nchashes, ncstats, ndbc, plotting, spectra, stndata
 
 # public API (i.e. "from cdippy import *")
-__all__ = ["plots", "cdipnc", "nchashes", "ncstats", "ndbc", "spectra", "stndata"]
+__all__ = ["cdipnc", "nchashes", "ncstats", "ndbc", "plotting", "spectra", "stndata"]

cdippy/plots/__init__.py

@@ -1,3 +0,0 @@
-from . import annual_hs_boxplot, compendium, sst_climatology
-
-__all__ = ["annual_hs_boxplot", "compendium", "sst_climatology"]

cdippy/plots/compendium.py

@@ -15,7 +15,7 @@
 
 
 def make_plot(
-    stns: str, start: datetime, end: datetime, params: str, x_inch: int
+    stns: str, start: datetime, end: datetime, params: str, x_inch: int = None
 ) -> tuple:
     """CDIP's classic compendium plot for multiple stations and parameters.
 

cdippy/plots/sst_climatology.py

@@ -14,7 +14,7 @@
 import matplotlib.pyplot as plt  # noqa: E402
 
 
-def make_plot(stn: str, x_inch: int = None, y_inch: int = None):
+def make_plot(stn: str, x_inch: int = None, y_inch: int = None) -> tuple:
     """
     Year-long Climatology of Sea Surface Temperature across all years of available data for a station.
 

cdippy/plotting.py

@@ -0,0 +1,55 @@
+import plots.annual_hs_boxplot as hs
+import plots.compendium as comp
+import plots.sst_climatology as sst
+
+from matplotlib.pyplot import Figure
+
+
+def make_annual_hs_boxplot(stn: str, year: int) -> Figure:
+    """
+    Create a boxplot of annual significant wave heights for a station.
+
+    Args:
+        stn (str): A 5-char station identifier, e.g. '100p1'.
+        year (int): The year to plot.
+
+    Returns:
+        fig (Figure): A matplotlib.pyplot.Figure object for the created plot.
+    """
+
+    return hs.make_plot(stn, year)
+
+
+def make_compendium_plot(
+    stns: str, start: str, end: str, params: str, x_inch: int
+) -> Figure:
+    """CDIP's classic compendium plot for multiple stations and parameters.
+
+    Args:
+        stns (str): A comma-delimited list of 5-char station identifiers, e.g. '100p1,201p1'.
+        start (str): Start time of data series formatted as 'yyyymm[ddHHMMss]' where 'ddHHMMss' are optional components.
+        end (str): End time of data series ('yyyymm[ddHHMMss]') If 'None' is provided, defaults to the current date and time.
+        params (str): A comma-delimited string of parameter names, e.g. 'waveHs,waveTp'.
+
+    Returns:
+        fig (Figure): A matplotlib.pyplot.Figure object for the created plot.
+
+    """
+
+    return comp.make_plot(stns, start, end, params, x_inch)
+
+
+def make_sst_climatology_plot(
+    stn: str, x_inch: int = None, y_inch: int = None
+) -> Figure:
+    """
+    Create a plot of yearly climatology of sea surface temperature at a station for all years of available data.
+
+    Args:
+        stn (str): A 5-char station identifier, e.g. '100p1'.
+
+    Returns:
+        fig (Figure): A matplotlib.pyplot.Figure object for the created plot.
+    """
+
+    return sst.make_plot(stn, x_inch, y_inch)

docs/api.md

@@ -12,6 +12,9 @@
 ::: cdippy.ndbc
 
 
+::: cdippy.plotting
+
+
 ::: cdippy.spectra