fixed docs and linting

Author: birnbaum

docs/conf.py

@@ -75,8 +75,17 @@ def get_latest_git_tag():
 # -- Options for HTML output ------
 html_theme = "furo"
 
-# Configure JavaScript files for Plotly support
-html_js_files = [
-    "require.min.js",
-    "custom.js",
-]
+nbsphinx_prolog = r"""
+.. raw:: html
+
+    <script src='https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js'></script>
+    <script src='https://cdn.plot.ly/plotly-2.27.0.min.js'></script>
+    <script>
+        require.config({
+            paths: {
+                'plotly': 'https://cdn.plot.ly/plotly-2.27.0.min.js'
+            }
+        });
+    </script>
+
+"""

vessim/plot.py

@@ -15,7 +15,7 @@ def plot_trace(
     default_visible: Optional[str] = None,
     scale: Optional[float] = None,
     y_axis_title: Optional[str] = None,
-    dataset_name: Optional[str] = None
+    dataset_name: Optional[str] = None,
 ) -> Figure:
     """Plot a Vessim Trace using Plotly.
 
@@ -60,22 +60,15 @@ def plot_trace(
             go.Scatter(
                 x=df.index,
                 y=df[column_name],
-                name=column_name if len(df.columns) == 1 else "Carbon Intensity"
+                name=column_name if len(df.columns) == 1 else "Carbon Intensity",
             )
         )
         showlegend = False
     else:
         # Multi-column datasets (like solar data)
         for col in df.columns:
             visible = True if col == default_visible else "legendonly"
-            fig.add_trace(
-                go.Scatter(
-                    x=df.index,
-                    y=df[col],
-                    visible=visible,
-                    name=col
-                )
-            )
+            fig.add_trace(go.Scatter(x=df.index, y=df[col], visible=visible, name=col))
         showlegend = True
 
     # Update layout
@@ -84,9 +77,9 @@ def plot_trace(
         xaxis_title="Date",
         yaxis_title=y_axis_title,
         showlegend=showlegend,
-        hovermode='x unified' if len(df.columns) > 1 else 'x',
+        hovermode="x unified" if len(df.columns) > 1 else "x",
         margin={"l": 0, "t": 40, "b": 0, "r": 0},
-        autosize=True
+        autosize=True,
     )
 
     return fig
@@ -98,10 +91,9 @@ def plot_microgrid_trace(
     actors: Optional[List[str]] = None,
     include_system_power: bool = True,
     include_storage: bool = True,
-    title: Optional[str] = None,
-    height: int = 800,
+    height: int = 600,
     actor_colors: Optional[dict] = None,
-    layout: str = "detailed"
+    layout: str = "detailed",
 ) -> Figure:
     """Plot microgrid trace with actors, system power, and battery state.
 
@@ -114,7 +106,6 @@ def plot_microgrid_trace(
         actors: List of actor names to plot. If None, auto-detects from columns ending in '.p'
         include_system_power: Whether to include the system power (p_delta, p_grid)
         include_storage: Whether to include the storage subplot (storage.soc)
-        title: Overall plot title. If None, uses auto-generated title
         height: Total plot height in pixels
         actor_colors: Dict mapping actor names to colors. If None, uses default Plotly colors
         layout: "detailed" for 3 subplots, "overview" for 2 subplots (default: "detailed")
@@ -137,40 +128,38 @@ def plot_microgrid_trace(
     """
     # Auto-detect actors if not specified
     if actors is None:
-        actors = [col.replace('.p', '') for col in df.columns if col.endswith('.p')]
+        actors = [col.replace(".p", "") for col in df.columns if col.endswith(".p")]
 
     # Handle layout options
     if layout == "overview":
         # Use overview layout: combine actors and system power in one subplot
-        has_storage = include_storage and 'storage.soc' in df.columns
+        has_storage = include_storage and "storage.soc" in df.columns
         subplot_count = 2 if has_storage else 1
-        
+
         subplot_titles = ["Power Overview"]
         if has_storage:
             subplot_titles.append("Battery State of Charge")
-        
+
         row_heights = [0.67, 0.33] if subplot_count == 2 else [1.0]
-        
+
     else:  # detailed layout
         # Determine subplot configuration - separate subplots
         subplot_count = 1  # Always include actors
         if include_system_power:
             subplot_count += 1
-        if include_storage and 'storage.soc' in df.columns:
+        if include_storage and "storage.soc" in df.columns:
             subplot_count += 1
 
         # Create subplot titles
         subplot_titles = ["Actor Power"]
         if include_system_power:
             subplot_titles.append("System Power")
-        if include_storage and 'storage.soc' in df.columns:
+        if include_storage and "storage.soc" in df.columns:
             subplot_titles.append("Battery State of Charge")
 
         # Calculate height ratios - give more space to actors plot
         row_heights = (
-            [0.5] + [0.5 / (subplot_count - 1)] * (subplot_count - 1)
-            if subplot_count > 1
-            else [1]
+            [0.5] + [0.5 / (subplot_count - 1)] * (subplot_count - 1) if subplot_count > 1 else [1]
         )
 
     # Create subplots
@@ -180,18 +169,18 @@ def plot_microgrid_trace(
         shared_xaxes=True,
         subplot_titles=subplot_titles,
         row_heights=row_heights,
-        vertical_spacing=0.08
+        vertical_spacing=0.08,
     )
 
     # Define default colors for common actor types
     default_colors = {
-        'server': '#d62728',      # red
-        'solar_panel': '#ff7f0e', # orange
-        'solar': '#ff7f0e',       # orange
-        'wind': '#2ca02c',        # green
-        'storage': '#9467bd',     # purple
-        'load': '#8c564b',        # brown
-        'battery': '#9467bd',     # purple
+        "server": "#d62728",  # red
+        "solar_panel": "#ff7f0e",  # orange
+        "solar": "#ff7f0e",  # orange
+        "wind": "#2ca02c",  # green
+        "storage": "#9467bd",  # purple
+        "load": "#8c564b",  # brown
+        "battery": "#9467bd",  # purple
     }
 
     current_row = 1
@@ -210,12 +199,12 @@ def plot_microgrid_trace(
             color = default_colors[actor]
 
         # Create display name
-        display_name = actor.replace('_', ' ').title()
+        display_name = actor.replace("_", " ").title()
         if layout == "overview":
             # Match notebook naming
-            if 'server' in actor.lower():
+            if "server" in actor.lower():
                 display_name = f"{display_name} power"
-            elif 'solar' in actor.lower():
+            elif "solar" in actor.lower():
                 display_name = f"{display_name} power"
 
         fig.add_trace(
@@ -224,146 +213,128 @@ def plot_microgrid_trace(
                 y=df[actor_col],
                 name=display_name,
                 line=dict(color=color) if color else {},
-                hovertemplate=f"{actor}: %{{y:.1f}} W<extra></extra>"
+                hovertemplate=f"{actor}: %{{y:.1f}} W<extra></extra>",
             ),
             row=current_row,
-            col=1
+            col=1,
         )
 
     # Add system power to first subplot if overview layout
     if layout == "overview" and include_system_power:
-        if 'p_delta' in df.columns:
+        if "p_delta" in df.columns:
             fig.add_trace(
                 go.Scatter(
-                    x=df.index,
-                    y=df['p_delta'],
-                    name="Delta power",
-                    line=dict(color='gray')
+                    x=df.index, y=df["p_delta"], name="Delta power", line=dict(color="gray")
                 ),
                 row=current_row,
-                col=1
+                col=1,
             )
-        
-        if 'p_grid' in df.columns:
+
+        if "p_grid" in df.columns:
             fig.add_trace(
-                go.Scatter(
-                    x=df.index,
-                    y=df['p_grid'],
-                    name="Grid power", 
-                    line=dict(color='blue')
-                ),
+                go.Scatter(x=df.index, y=df["p_grid"], name="Grid power", line=dict(color="blue")),
                 row=current_row,
-                col=1
+                col=1,
             )
 
     # Format first subplot
     fig.update_yaxes(title_text="Power (W)", row=current_row, col=1)
     fig.update_xaxes(
-        showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+        showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
     )
     fig.update_yaxes(
-        showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+        showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
     )
 
     current_row += 1
 
     # 2. System Power Plot (detailed layout only)
     if layout == "detailed" and include_system_power and current_row <= subplot_count:
-        if 'p_delta' in df.columns:
+        if "p_delta" in df.columns:
             fig.add_trace(
                 go.Scatter(
                     x=df.index,
-                    y=df['p_delta'],
+                    y=df["p_delta"],
                     name="Delta Power",
-                    line=dict(color='gray'),
-                    hovertemplate="Delta Power: %{y:.1f} W<extra></extra>"
+                    line=dict(color="gray"),
+                    hovertemplate="Delta Power: %{y:.1f} W<extra></extra>",
                 ),
                 row=current_row,
-                col=1
+                col=1,
             )
 
-        if 'p_grid' in df.columns:
+        if "p_grid" in df.columns:
             fig.add_trace(
                 go.Scatter(
                     x=df.index,
-                    y=df['p_grid'],
+                    y=df["p_grid"],
                     name="Grid Power",
-                    line=dict(color='blue'),
-                    hovertemplate="Grid Power: %{y:.1f} W<extra></extra>"
+                    line=dict(color="blue"),
+                    hovertemplate="Grid Power: %{y:.1f} W<extra></extra>",
                 ),
                 row=current_row,
-                col=1
+                col=1,
             )
 
         fig.update_yaxes(title_text="Power (W)", row=current_row, col=1)
         fig.update_xaxes(
-            showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+            showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
         )
         fig.update_yaxes(
-            showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+            showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
         )
 
         current_row += 1
 
     # 3. Battery State of Charge Plot
-    if include_storage and 'storage.soc' in df.columns and current_row <= subplot_count:
+    if include_storage and "storage.soc" in df.columns and current_row <= subplot_count:
         # Main SoC trace
         fig.add_trace(
             go.Scatter(
                 x=df.index,
-                y=df['storage.soc'] * 100,
+                y=df["storage.soc"] * 100,
                 name="Battery SoC",
-                line=dict(color='green'),
-                fill='tonexty' if len(fig.data) == 0 else 'tozeroy',
-                fillcolor='rgba(0,128,0,0.1)',
-                hovertemplate="SoC: %{y:.1f}%<extra></extra>"
+                line=dict(color="green"),
+                fill="tonexty" if len(fig.data) == 0 else "tozeroy",
+                fillcolor="rgba(0,128,0,0.1)",
+                hovertemplate="SoC: %{y:.1f}%<extra></extra>",
             ),
             row=current_row,
-            col=1
+            col=1,
         )
 
         # Add minimum SoC line if available
-        if 'storage.min_soc' in df.columns:
-            min_soc_value = df['storage.min_soc'].iloc[0] * 100
+        if "storage.min_soc" in df.columns:
+            min_soc_value = df["storage.min_soc"].iloc[0] * 100
             fig.add_hline(
                 y=min_soc_value,
                 line_dash="dash",
                 line_color="gray",
                 annotation_text=f"Min SoC ({min_soc_value:.0f}%)",
                 annotation_position="top right",
                 row=current_row,
-                col=1
+                col=1,
             )
 
         fig.update_yaxes(title_text="State of Charge (%)", range=[0, 100], row=current_row, col=1)
         fig.update_xaxes(
-            showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+            showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
         )
         fig.update_yaxes(
-            showgrid=True, gridwidth=1, gridcolor='rgba(128,128,128,0.3)', row=current_row, col=1
+            showgrid=True, gridwidth=1, gridcolor="rgba(128,128,128,0.3)", row=current_row, col=1
         )
 
-    # Auto-generate title if not provided
-    if title is None:
-        if layout == "overview":
-            title = "Solar vs Grid Power Over 24 Hours" if include_storage else "Power Overview"
-        else:
-            title = "Simulation Results"
-
     # Update overall layout
     fig.update_layout(
-        title=title,
         height=height,
-        hovermode='x unified',
+        hovermode="x unified",
         showlegend=True,
-        legend=dict(
-            orientation="h",
-            yanchor="bottom",
-            y=1.02,
-            xanchor="right",
-            x=1
-        ) if layout == "detailed" else None,
-        margin=dict(l=0, t=60, b=0, r=0) if layout == "overview" else None
+        legend=(
+            dict(orientation="h", yanchor="bottom", y=1.02, xanchor="right", x=1)
+            if layout == "detailed"
+            else None
+        ),
+        margin=dict(l=0, t=60, b=0, r=0) if layout == "overview" else None,
     )
 
     # Format x-axis for bottom subplot only
@@ -372,7 +343,6 @@ def plot_microgrid_trace(
     return fig
 
 
-
 def _generate_title(dataset_name: str) -> str:
     """Generate a title from dataset name."""
     if "solcast2022_global" in dataset_name:
@@ -397,4 +367,3 @@ def _detect_y_axis_title(dataset_name: str, scale: Optional[float] = None) -> st
         return "g/kWh"
     else:
         return "Value"
-