Implement session-aware UI management for SCHISM output and calibration plots

Author: dwr-psandhu

schismviz/out2dui.py

@@ -352,6 +352,7 @@ def _make_plot_action(self):
 
 import click
 import yaml as _yaml
+from schismviz.session import serve_session_app
 
 
 def _load_yaml_section(config_file, section):
@@ -486,16 +487,15 @@ def show_out2d_ui(
         variables_arg = [v.strip() for v in str(variables_str).split(",") if v.strip()]
 
     # ---- build manager and launch UI ---------------------------------------
-    mgr = SchismOut2DUIManager(
-        *files,
-        nodes=nodes_arg,
-        variables=variables_arg,
-        study_name=cfg.get("title", "SCHISM out2d"),
-    )
-
     dashboard_title = cfg.get("title", "SCHISM out2d")
     server_port = int(cfg.get("port", 5006))
 
-    DataUI(mgr).create_view(title=dashboard_title).show(
-        port=server_port, open=show
-    )
+    def build_manager():
+        return SchismOut2DUIManager(
+            *files,
+            nodes=nodes_arg,
+            variables=variables_arg,
+            study_name=cfg.get("title", "SCHISM out2d"),
+        )
+
+    serve_session_app(build_manager, title=dashboard_title, port=server_port, open=show)

schismviz/schismcalibplotui.py

@@ -546,6 +546,7 @@ def get_name_to_color(self):
 
 
 import click
+from schismviz.session import serve_session_app
 
 
 @click.command()
@@ -573,7 +574,8 @@ def get_name_to_color(self):
     default=False,
     help="Validate config and print resolved settings without launching the UI",
 )
-def schism_calib_plot_ui(config_file, base_dir=None, dry_run=False, **kwargs):
+@click.option("--port", default=5006, help="Port to serve the UI on")
+def schism_calib_plot_ui(config_file, base_dir=None, dry_run=False, port=5006, **kwargs):
     """
     config_file: str
         yaml file containing configuration
@@ -599,6 +601,8 @@ def _serialize_for_yaml(value):
         click.echo("Configuration validated successfully.")
         click.echo(yaml.safe_dump(_serialize_for_yaml(manager.config), sort_keys=False))
         return
-    DataUI(manager, crs=ccrs.UTM(10)).create_view(
-        title="Schism Calibration Plot UI"
-    ).show()
+
+    def build_manager():
+        return SchismCalibPlotUIManager(config_file, base_dir=base_dir, **kwargs)
+
+    serve_session_app(build_manager, title="Schism Calibration Plot UI", crs=ccrs.UTM(10), port=port)

schismviz/schismui.py

@@ -325,6 +325,7 @@ def get_map_marker_columns(self):
 
 import click
 import yaml
+from schismviz.session import serve_session_app
 
 
 @click.command()
@@ -348,6 +349,7 @@ def get_map_marker_columns(self):
 @click.option("--flux_out", default="flux.out", help="Path to the flux.out file")
 @click.option("--reftime", default=None, help="Reference time")
 @click.option("--yaml-file", default=None, help="Path to the yaml file")
+@click.option("--port", default=5006, help="Port to serve the UI on")
 def show_schism_output_ui(
     schism_dir=".",
     flux_xsect_file="flow_station_xsects.yaml",
@@ -357,6 +359,7 @@ def show_schism_output_ui(
     repo_dir="screened",
     inventory_file="inventory_datasets.csv",
     yaml_file=None,
+    port=5006,
 ):
     """
     Shows Data UI for SCHISM output files.
@@ -442,13 +445,12 @@ def show_schism_output_ui(
     else:
         logger.info("No datastore inventory file found (%s); running without observation datastore.", inventory_file)
 
-    # Create the UI
-    ui = DataUI(
-        SchismOutputUIDataManager(
+    # Launch the session-aware UI
+    def build_manager():
+        return SchismOutputUIDataManager(
             *studies,
             datastore=ds,
             time_range=time_range,
-        ),
-        crs=ccrs.UTM(10),
-    )
-    ui.create_view(title="Schism Output UI").show()
+        )
+
+    serve_session_app(build_manager, title="Schism Output UI", crs=ccrs.UTM(10), port=port)

schismviz/session.py

@@ -0,0 +1,71 @@
+"""schismviz.session — Session persistence for schismviz CLI apps.
+
+Thin re-export shim over :mod:`dvue.session_persistence`.  All logic lives
+in dvue so that other dvue-based apps can reuse it.
+
+The diskcache default for schismviz is ``~/.schismviz_sessions`` (rather
+than dvue's generic ``~/.dvue_sessions``) so sessions from different dvue
+apps on the same machine are kept separate.  The cookie name is
+``"schismviz_user_id"`` to avoid collisions when multiple dvue apps are
+served on the same origin.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from dvue.session_persistence import (
+    install_session_handler,
+    snapshot,
+    restore,
+)
+from dvue.session_persistence import serve_session_app as _serve_session_app
+
+__all__ = ["install_session_handler", "snapshot", "restore", "serve_session_app"]
+
+_DEFAULT_CACHE_DIR = Path.home() / ".schismviz_sessions"
+_DEFAULT_COOKIE_NAME = "schismviz_user_id"
+
+
+def serve_session_app(
+    build_manager_fn,
+    title: str,
+    port: int = 0,
+    crs=None,
+    station_id_column: str | None = None,
+    cache_dir: str | Path | None = None,
+    **pn_serve_kwargs,
+) -> None:
+    """Launch a session-aware Panel app for a schismviz manager.
+
+    Delegates to :func:`dvue.session_persistence.serve_session_app` with
+    ``cache_dir`` defaulting to ``~/.schismviz_sessions`` and
+    ``cookie_name`` defaulting to ``"schismviz_user_id"``.
+
+    Parameters
+    ----------
+    build_manager_fn:
+        Zero-argument callable returning a fresh ``DataUIManager`` instance.
+    title:
+        Browser title; also used as the URL path key.
+    port:
+        TCP port (``0`` = random available port).
+    crs:
+        Cartopy CRS for the map panel.  ``None`` → no map.
+    station_id_column:
+        Column identifying stations in the catalog.
+    cache_dir:
+        Diskcache directory.  Defaults to ``~/.schismviz_sessions``.
+    **pn_serve_kwargs:
+        Forwarded to ``pn.serve()``.
+    """
+    _serve_session_app(
+        build_manager_fn,
+        title=title,
+        port=port,
+        crs=crs,
+        station_id_column=station_id_column,
+        cookie_name=_DEFAULT_COOKIE_NAME,
+        cache_dir=cache_dir if cache_dir is not None else _DEFAULT_CACHE_DIR,
+        **pn_serve_kwargs,
+    )