save before hera maintenance

src/jcb/observation_chronicle/conv_chronicle.py

@@ -26,10 +26,150 @@
 }
 
 
+# --------------------------------------------------------------------------------------------------
+
+def add_to_evolving_observing_system(evolving_observing_system, datetime, station_reject_list):
+
+    """
+    Add the rejected station IDs to the evolving observing system. This function is used to add the
+    station IDs to the evolving observing system. The evolving observing system is a list of
+    dictionaries where each dictionary has a datetime key and a station_reject_list key. The datetime key
+    is a datetime object and the station_reject_list key is a list of strings of station IDs that
+    are to be rejected by quality control procedures.
+
+    Args:
+        evolving_observing_system (list): The evolving observing system.
+        datetime (datetime): The datetime of the station IDs.
+        station_reject_list (list): List of strings of station IDs.
+
+    Returns:
+        None (None): Mutable evolving_observing_system is updated in place.
+    """
+
+    # Temporary dictionary
+    temp_dict = {}
+    temp_dict['datetime'] = copy.deepcopy(datetime)
+    temp_dict['station_reject_list'] = copy.deepcopy(station_reject_list)
+
+    # Append to the evolving observing system
+    evolving_observing_system.append(temp_dict)
+
+
 # --------------------------------------------------------------------------------------------------
 
 def process_station_chronicles(ob_type, window_begin, window_final, chronicle_in):
-    print('hello world')
-    return {}
+
+    """
+    Process conventional observation station chronicles for a specified time window, determining
+    which station IDs should be included in the reject list based on the chronicle's actions.
+
+    This function iterates through an observation type's chronological data records, adjusting
+    the station reject list as dictated by the chronicles. It validates the chronicle structure,
+    ensures chronological order, and applies adjustments or reverts as specified. The final output
+    is a set of station IDs adjusted according to the specified window and strategies.
+
+    Args:
+        window_begin (datetime): The beginning of the data assimilation window.
+        window_final (datetime): The end of the data assimilation window.
+        chronicle (dict): A dictionary containing the observation type's commissioning data,
+                          station reject list, and a list of chronological actions (chronicles) that
+                          include  adjustments or reverts of station IDs.
+
+    Returns:
+        list: A list of strings of station IDs that should be included in a reject list
+              according to the specified time window and the strategies chosen for variable adjustments.
+
+    Raises:
+        AbortException: If any of the preconditions are not met.
+
+    Note:
+        The function assumes that the station IDs are properly structured
+        in the input `chronicle` dictionary.    
+    """
+
+    # Copy the incoming chronicle to avoid modifying the original
+    # -----------------------------------------------------------
+    chronicle = copy.deepcopy(chronicle_in)
+
+    # Create a message to prepend any errors with
+    # -------------------------------------------
+    errors_message_pre = f"Error processing station reject list chronicle for {ob_type}"
+
+    # Commissioned time for this platform
+    # -----------------------------------
+    commissioned = jcb.datetime_from_conf(chronicle['commissioned'])
+
+    # Check for decommissioned time
+    # -----------------------------
+    decommissioned = chronicle.get('decommissioned', None)
+    if decommissioned:
+        decommissioned = jcb.datetime_from_conf(decommissioned)
+
+        # Abort if window_final is after decommissioned
+        jcb.abort_if(window_begin >= decommissioned,
+                     f"{errors_message_pre} The beginning of the window falls after the "
+                     "decommissioned date. This chronicle should not be used after the "
+                     "decommissioned date.")
+
+    # List of dictionaries to hold the observing system as it evolves through the chronicles
+    # ----------------------------------------------------------------------------
+    evolving_observing_system = []
+
+    # Initial list of stations to reject
+    # ----------------------------------
+    station_reject_list = chronicle.get('stations_to_reject')
+
+    # Store chronicle at the initial commissioned date
+    add_to_evolving_observing_system(evolving_observing_system, commissioned, station_reject_list)    
+
+    # Get chronicles list
+    # -------------------
+    chronicles = chronicle.get('chronicles', [])
+
+    # Validation checks on the chronicles
+    # -----------------------------------
+
+    # Check chronicles for chronological order and that they are unique
+    action_dates = [jcb.datetime_from_conf(chronicle['action_date']) for chronicle in chronicles]
+    jcb.abort_if(action_dates != sorted(action_dates),
+                 f"{errors_message_pre} The chronicles are not in chronological order.")
+    jcb.abort_if(len(action_dates) != len(set(action_dates)),
+                 f"{errors_message_pre} The chronicles are not unique. Ensure no two chronicles "
+                 "have the same date.")
+
+    # Prepend the action dates with the commissioned date
+    action_dates = [commissioned] + action_dates
+
+    # Loop through the chronicles and at each time there will be a complete set of
+    # station IDs to reject with the values specified by the chronicle.
+    # -------------------------------------------------------------------------------------------
+    for chronicle in chronicles:
+
+        # Chronicle action date
+        ch_action_date = jcb.datetime_from_conf(chronicle['action_date'])
+        ch_action_date_iso = datetime.isoformat(ch_action_date)
+
+        # Update the error message prefix with the action date
+        errors_message_pre_ad = "Error processing observation chronicle with action date " + \
+                                f"{ch_action_date_iso} for {ob_type}:"
+
+        # If the chronicle has key revert_to_previous_chronicle
+        if 'revert_to_previous_date_time' in chronicle:
+            previous_datetime = jcb.datetime_from_conf(chronicle['revert_to_previous_date_time'])
+
+            # Find the nearest previous datetime in the action_dates list (without going over)
+            index_of_previous = get_left_index(errors_message_pre_ad, action_dates,
+                                               previous_datetime)
+
+            # Update the channel values to the previous chronicle (using evolving observing system)
+            station_reject_list = copy.deepcopy(
+                evolving_observing_system[index_of_previous]['station_reject_list'])
+
+        # Add the values after the action to the evolving observing system
+        add_to_evolving_observing_system(evolving_observing_system, ch_action_date, station_reject_list)
+
+    print(station_reject_list)
+
+    return []
 
 # --------------------------------------------------------------------------------------------------

test/observation_chronicles/test_conv_processing.py

@@ -23,7 +23,7 @@
 
 # observation type initial configuration
 # --------------------------------
-reject_list: ['KBWI']
+stations_to_reject: ['KBWI', 'KIAD']
 
 # Chronicle of changes for this observation type
 # ----------------------------------------