Add Div to display run times (#278)

* feat(src/nectarchain/dqm/bokeh_app):

- app_hooks.py: implement get_run_times function to extract run start timestamp and first and last recorded event timestamps

* feat(src/nectarchain/dqm/bokeh_app):

- main.py: implement Div to display run times

* feat(src/nectarchain/dqm/bokeh_app)

- main.py: update now updates also the run times

- app_hooks.py: small refactor to get datetime from timestamp

* test(src/nectarchain/dqm/bokeh_app/tests):

- test_app_hooks.py: implement test for the get_run_times function

* fix(src/nectarchain/dqm/bokeh_app):

- app_hooks.py: specify time zone in datetime.fromtimestamp in get_run_times to avoid issues related to local time zone in tests

Author: alessandromontanari

src/nectarchain/dqm/bokeh_app/app_hooks.py

@@ -2,6 +2,7 @@
 import json
 import os
 import re
+from datetime import datetime, timezone
 
 import numpy as np
 from astropy.coordinates import SkyCoord
@@ -66,6 +67,47 @@ def get_rundata(src, runid):
     return run_data
 
 
+def get_run_times(source):
+    """Extract important time stamps for the provided run data
+
+    Parameters
+    ----------
+    source : dict
+        Dictionary returned by `get_rundata`
+
+    Returns
+    -------
+    run_start_time_dt : datetime.datetime
+        Time of the start of the run in %Y-%m-%d %H:%M:%S format
+    first_event_time_dt : datetime.datetime
+        Time when the first event was recorded in %Y-%m-%d %H:%M:%S format
+    last_event_time_dt : datetime.datetime
+        Time when the last event was recorded in %Y-%m-%d %H:%M:%S format
+    """
+
+    run_start_time = int(source["START-TIMES"]["Run start time"].flatten()[0])
+    run_start_time_dt = datetime.fromtimestamp(
+        run_start_time, tz=timezone.utc
+    ).strftime("%Y-%m-%d %H:%M:%S")
+    first_event_time = int(source["START-TIMES"]["First event"].flatten()[0])
+    first_event_time_dt = datetime.fromtimestamp(
+        first_event_time, tz=timezone.utc
+    ).strftime("%Y-%m-%d %H:%M:%S")
+    last_event_time = int(source["START-TIMES"]["Last event"].flatten()[0])
+    last_event_time_dt = datetime.fromtimestamp(
+        last_event_time, tz=timezone.utc
+    ).strftime("%Y-%m-%d %H:%M:%S")
+
+    logger.info(
+        f"Successfully extracted run times: "
+        f"run start time {run_start_time_dt}, "
+        f"first event time {first_event_time_dt}, "
+        f"last event time {last_event_time_dt}"
+    )
+
+    return run_start_time_dt, first_event_time_dt, last_event_time_dt
+
+
 def make_timelines(source, runid=None):
     """Make timeline plots for pixel quantities evolving with time
 

src/nectarchain/dqm/bokeh_app/main.py

@@ -1,4 +1,5 @@
 from app_hooks import (
+    get_run_times,
     get_rundata,
     make_camera_displays,
     make_timelines,
@@ -8,7 +9,7 @@
 
 # bokeh imports
 from bokeh.layouts import column, gridplot, row
-from bokeh.models import Select, TabPanel, Tabs
+from bokeh.models import Div, Select, TabPanel, Tabs
 from bokeh.plotting import curdoc
 
 # ctapipe imports
@@ -64,11 +65,30 @@ def update(attr, old, new):
 
     tab_camera_displays = update_camera_displays(source, displays, runid)
     tab_timelines = update_timelines(source, timelines, runid)
+    run_start_time_dt, first_event_time_dt, last_event_time_dt = get_run_times(source)
+
+    run_times_string = Div(
+        text=f"""
+        <div style="
+            background-color: #f0f8ff;
+            border-radius: 10px;
+            padding: 10px;
+            width: fit-content;
+            font-size: 14px;
+        ">
+            <p>Run start time: {run_start_time_dt}</p>
+            <p>First event recorded at: {first_event_time_dt}</p>
+            <p>Last event recorded at: {last_event_time_dt}</p>
+        </div>
+        """
+    )
 
     # Combine panels into tabs
     tabs = Tabs(tabs=[tab_camera_displays, tab_timelines], sizing_mode="scale_width")
 
     page_layout.children[1] = tabs
+    page_layout.children[0].children[1] = run_times_string
+
     logger.info("Updated layouts and TabPanel objects for tabs.")
 
 
@@ -97,7 +117,24 @@ def update(attr, old, new):
 displays = make_camera_displays(source, runid)
 timelines = make_timelines(source, runid)
 
-controls = row(run_select)
+run_start_time_dt, first_event_time_dt, last_event_time_dt = get_run_times(source)
+run_times_string = Div(
+    text=f"""
+    <div style="
+        background-color: #f0f8ff;
+        border-radius: 10px;
+        padding: 10px;
+        width: fit-content;
+        font-size: 14px;
+    ">
+        <p>Run start time: {run_start_time_dt}</p>
+        <p>First event recorded at: {first_event_time_dt}</p>
+        <p>Last event recorded at: {last_event_time_dt}</p>
+    </div>
+    """
+)
+
+controls = row(run_select, run_times_string)
 
 # # TEST:
 # attr = 'value'

src/nectarchain/dqm/bokeh_app/tests/test_app_hooks.py

@@ -76,6 +76,46 @@ def test_make_camera_displays():
         make_camera_displays(source=test_dict[runid], runid=runid)
 
 
+def test_get_run_times():
+    from datetime import datetime
+
+    from nectarchain.dqm.bokeh_app.app_hooks import get_run_times
+
+    # Create a test source dict with START-TIMES data
+    # Using np.array to simulate the structure expected by the function
+    run_start_time_ts = 1609459200  # 2021-01-01 00:00:00 UTC
+    first_event_time_ts = 1609459260  # 2021-01-01 00:01:00 UTC
+    last_event_time_ts = 1609462800  # 2021-01-01 01:00:00 UTC
+
+    source_with_times = {
+        "START-TIMES": {
+            "Run start time": np.array([run_start_time_ts]),
+            "First event": np.array([first_event_time_ts]),
+            "Last event": np.array([last_event_time_ts]),
+        }
+    }
+
+    run_start_time_dt, first_event_time_dt, last_event_time_dt = get_run_times(
+        source_with_times
+    )
+
+    # Verify the returned strings are in the correct format
+    assert isinstance(run_start_time_dt, str)
+    assert isinstance(first_event_time_dt, str)
+    assert isinstance(last_event_time_dt, str)
+
+    # Verify the format is YYYY-MM-DD HH:MM:SS
+    expected_format = "%Y-%m-%d %H:%M:%S"
+    datetime.strptime(run_start_time_dt, expected_format)
+    datetime.strptime(first_event_time_dt, expected_format)
+    datetime.strptime(last_event_time_dt, expected_format)
+
+    # Verify the values match the input timestamps
+    assert run_start_time_dt == "2021-01-01 00:00:00"
+    assert first_event_time_dt == "2021-01-01 00:01:00"
+    assert last_event_time_dt == "2021-01-01 01:00:00"
+
+
 def test_make_timelines():
     from nectarchain.dqm.bokeh_app.app_hooks import make_timelines