ft: improved experiment viewer metadata. Added doi badges. Wrapped up final pane dashboard details

pabloitu · pabloitu · commit cda4390e2684 · 2025-11-25T00:37:21.000+01:00
diff --git a/docs/tutorials/case_a.rst b/docs/tutorials/case_a.rst
@@ -16,6 +16,12 @@ The following example shows the definition of a testing experiment of a single *
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_b.rst b/docs/tutorials/case_b.rst
@@ -16,6 +16,12 @@ The following example is an experiment including **multiple** time-independent f
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_c.rst b/docs/tutorials/case_c.rst
@@ -16,6 +16,12 @@ The following example shows an experiment with **multiple time windows**.
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_d.rst b/docs/tutorials/case_d.rst
@@ -18,6 +18,12 @@ The following example shows an experiment whose forecasts are **retrieved from a
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_e.rst b/docs/tutorials/case_e.rst
@@ -16,6 +16,12 @@ This example shows how to run a realistic testing experiment (based on :ref:`Sch
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_f.rst b/docs/tutorials/case_f.rst
@@ -16,6 +16,12 @@ This example shows how set up an experiment with a **time-dependent** model, who
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
 
 .. contents:: Contents
     :local:
diff --git a/docs/tutorials/case_g.rst b/docs/tutorials/case_g.rst
@@ -14,6 +14,13 @@ Here, we set up a time-dependent model from its **source code** for an experimen
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
+
     For troubleshooting, run the experiment with:
 
     .. code-block:: console
diff --git a/docs/tutorials/case_h.rst b/docs/tutorials/case_h.rst
@@ -14,6 +14,13 @@ Here, we run an experiment that accesses, containerizes and executes multiple **
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
+
     For troubleshooting, run the experiment with:
 
     .. code-block:: console
diff --git a/docs/tutorials/case_i.rst b/docs/tutorials/case_i.rst
@@ -22,6 +22,13 @@ This case uses simple mock models as examples.
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
+
     For troubleshooting, run the experiment with:
 
     .. code-block:: console
diff --git a/docs/tutorials/case_j.rst b/docs/tutorials/case_j.rst
@@ -21,6 +21,19 @@ producing daily gridded forecasts and evaluating them with a Poisson N-test. The
         $ floatcsep run config.yml
 
     After the calculation is complete, the results will be summarized in ``results/report.md``.
+    The experiment region, catalog, forecasts and results can be viewed in the **Experiment Dashboard** with:
+
+    .. code-block:: console
+
+            $ floatcsep view config.yml
+
+
+    For troubleshooting, run the experiment with:
+
+    .. code-block:: console
+
+        $ floatcsep run config.yml --debug
+
 
 .. currentmodule:: floatcsep
 
diff --git a/floatcsep/evaluation.py b/floatcsep/evaluation.py
@@ -135,8 +135,10 @@ def parse_plots(
 
         """
         if isinstance(plot_func, str):
-
-            self.plot_func = [parse_csep_func(plot_func)]
+            try:
+                self.plot_func = [parse_csep_func(plot_func)]
+            except AttributeError:
+                self.plot_func = [None]
             self.plot_args = [plot_args] if plot_args else [{}]
             self.plot_kwargs = [plot_kwargs] if plot_kwargs else [{}]
 
@@ -161,16 +163,17 @@ def parse_plots(
         else:
             return
         for func_obj in self.plot_func:
-            func_name = f"{func_obj.__module__}.{func_obj.__name__}"
-            mode = self._PLOTS[func_name]
+            if func_obj is not None:
+                func_name = f"{func_obj.__module__}.{func_obj.__name__}"
+                mode = self._PLOTS[func_name]
 
-            if mode is None:
-                if self.type in ["sequential", "sequential_comparative", "batch"]:
-                    mode = "sequential"
-                else:
-                    mode = "aggregate"
+                if mode is None:
+                    if self.type in ["sequential", "sequential_comparative", "batch"]:
+                        mode = "sequential"
+                    else:
+                        mode = "aggregate"
 
-            self.plot_modes.append(mode)
+                self.plot_modes.append(mode)
 
     def prepare_args(
         self,
diff --git a/floatcsep/experiment.py b/floatcsep/experiment.py
@@ -94,6 +94,16 @@ class Experiment:
     def __init__(
         self,
         name: str = None,
+        doi: str = None,
+        authors: str = None,
+        journal: str = None,
+        manuscript_doi: str = None,
+        catalog_doi: str = None,
+        last_run: str = None,
+        floatcsep_version: str = None,
+        pycsep_version: str = None,
+        exp_time: str = None,
+        LICENSE: str = None,
         time_config: dict = None,
         region_config: dict = None,
         catalog: str = None,
@@ -121,6 +131,17 @@ def __init__(
         os.makedirs(Path(workdir, run_dir), exist_ok=True)
 
         self.name = name if name else "floatingExp"
+        self.authors = authors if authors else None
+        self.doi = doi if doi else None
+        self.journal = journal if journal else None
+        self.manuscript_doi = manuscript_doi if manuscript_doi else None
+        self.catalog_doi = catalog_doi if catalog_doi else None
+        self.last_run = last_run if last_run else None
+        self.floatcsep_version = floatcsep_version if floatcsep_version else None
+        self.pycsep_version = pycsep_version if pycsep_version else None
+        self.exp_time = exp_time if exp_time else None
+        self.LICENSE = LICENSE if LICENSE else None
+
         self.registry = ExperimentRegistry.factory(workdir=workdir, run_dir=run_dir)
         self.results_repo = ResultsRepository(self.registry)
         self.catalog_repo = CatalogRepository(self.registry)
diff --git a/floatcsep/postprocess/panel/layout.py b/floatcsep/postprocess/panel/layout.py
@@ -81,6 +81,7 @@ def _build_tabs(manifest: Manifest) -> pn.Tabs:
         ("Forecasts", tab_forecasts),
         ("Results", tab_results),
         tabs_location="left",
+        dynamic=True,
         sizing_mode="fixed",
     )
     return tabs
@@ -162,9 +163,6 @@ def _chip(text: str) -> pn.pane.Markdown:
     if getattr(manifest, "date_range", None):
         items.append(_chip(f"**Time frame**: {manifest.date_range}"))
 
-    if getattr(manifest, "region", None):
-        items.append(_chip(f"**Region**: {manifest.region.name}"))
-
     if getattr(manifest, "magnitudes", None):
         m_min = min(manifest.magnitudes)
         m_max = max(manifest.magnitudes)
@@ -178,6 +176,19 @@ def _chip(text: str) -> pn.pane.Markdown:
 
     items.append(_status_chip(manifest))
 
+    if getattr(manifest, "doi", None):
+        doi = manifest.doi.strip()
+        doi_badge_html = (
+            '<div style="display:flex;align-items:center;height:100%;">'
+            f'<a href="https://doi.org/{doi}">'
+            f'<img src="https://zenodo.org/badge/DOI/{doi}.svg" '
+            f'alt="DOI" style="height:16px; vertical-align:middle;">'
+            f"</a>"
+        )
+        items.append(
+            pn.pane.HTML(doi_badge_html, margin=(6, 0, 0, 0), styles={"opacity": "0.85"})
+        )
+
     if not items:
         return pn.Row()
 
diff --git a/floatcsep/postprocess/panel/manifest.py b/floatcsep/postprocess/panel/manifest.py
@@ -18,6 +18,16 @@ class Manifest:
     name: str
     start_date: str
     end_date: str
+    authors: str
+    doi: str
+    journal: str
+    manuscript_doi: str
+    exp_time: str
+    floatcsep_version: str
+    pycsep_version: str
+    last_run: str
+    catalog_doi: str
+    license: str
     date_range: str
     magnitudes: List[float]
     region: Optional[Any]  # Region object (e.g. CartesianGrid2D)
@@ -87,6 +97,15 @@ def build_manifest(experiment: Any, app_root: Optional[str] = None) -> Manifest:
     name = getattr(experiment, "name", "Experiment")
     start = getattr(experiment, "start_date", None)
     end = getattr(experiment, "end_date", None)
+    authors = getattr(experiment, "authors", None)
+    doi = getattr(experiment, "doi", None)
+    catalog_doi = getattr(experiment, "catalog_doi", None)
+    license_ = getattr(experiment, "LICENSE", None)
+    if authors:
+        if isinstance(authors, (list, tuple)):
+            authors = ", ".join(str(a) for a in authors)
+        else:
+            authors = str(authors)
 
     if isinstance(start, datetime.datetime) and isinstance(end, datetime.datetime):
         date_range = f"{start.date()} — {end.date()}"
@@ -216,11 +235,20 @@ def build_manifest(experiment: Any, app_root: Optional[str] = None) -> Manifest:
     config_file = getattr(experiment, "config_file", None)
     model_config_path = getattr(experiment, "model_config", None)
     test_config_path = getattr(experiment, "test_config", None)
-
     return Manifest(
         name=name,
         start_date=start.date().isoformat(),
         end_date=end.date().isoformat(),
+        authors=authors,
+        journal=getattr(experiment, "journal", None),
+        manuscript_doi=getattr(experiment, "manuscript_doi", None),
+        floatcsep_version=getattr(experiment, "floatcsep_version", None),
+        pycsep_version=getattr(experiment, "pycsep_version", None),
+        last_run=getattr(experiment, "last_run", None),
+        exp_time=getattr(experiment, "exp_time", None),
+        doi=doi,
+        catalog_doi=catalog_doi,
+        license=license_,
         date_range=date_range,
         magnitudes=magnitudes,
         region=region,
diff --git a/floatcsep/postprocess/panel/views/cats.py b/floatcsep/postprocess/panel/views/cats.py
@@ -14,7 +14,12 @@
 from bokeh.plotting import figure
 
 from ..manifest import Manifest
-from .utils import build_region_basemap, lonlat_to_mercator, parse_time_window_strings
+from .utils import (
+    build_region_basemap,
+    lonlat_to_mercator,
+    parse_time_window_strings,
+    make_doi_badge,
+)
 from floatcsep.utils.file_io import CatalogParser
 
 
@@ -654,6 +659,10 @@ def _catalog_metadata_section(manifest: Manifest) -> pn.panel:
     if name != cat_path:
         lines.append(f"- **Name:** {name}")
 
+    provider = getattr(manifest, "catalog_provided", None)
+    if provider:
+        lines.append(f"- **Provider:** `{provider}`")
+
     lines.append(f"- **Event count:** {csep_cat.event_count}")
 
     start_time = getattr(csep_cat, "start_time", None)
@@ -696,6 +705,11 @@ def _catalog_metadata_section(manifest: Manifest) -> pn.panel:
     filters = getattr(csep_cat, "filters", None)
     if filters:
         lines.append(f"- **Filters:** `{filters}`")
+    # Experiment DOI (e.g. Zenodo for the experiment bundle)
+    doi = getattr(manifest, "catalog_doi", None)
+    if doi:
+        badge = make_doi_badge(doi)
+        lines.append(f"- **DOI:** {badge}")
 
     date_accessed = getattr(csep_cat, "date_accessed", None)
     if date_accessed:
diff --git a/floatcsep/postprocess/panel/views/exp.py b/floatcsep/postprocess/panel/views/exp.py
diff --git a/floatcsep/postprocess/panel/views/forecasts.py b/floatcsep/postprocess/panel/views/forecasts.py
diff --git a/floatcsep/postprocess/panel/views/utils.py b/floatcsep/postprocess/panel/views/utils.py
diff --git a/requirements.txt b/requirements.txt
diff --git a/requirements_dev.txt b/requirements_dev.txt
