Added index descriptions and input data to Handler

climada_petals/hazard/copernicus_forecast/handler.py

@@ -82,6 +82,62 @@ def __init__(self, data_dir='.', URL = None, KEY = None):
         self.URL = URL
 
 
+        # Dictionary with explanations and input data for each index
+        self.index_explanations = {
+            "HIA": {
+                "explanation": "Heat Index Adjusted: This indicator measures apparent temperature, considering both air temperature and humidity, providing a more accurate perception of how hot it feels.",
+                "input_data": ["2m temperature (t2m)", "2m dewpoint temperature (d2m)"]
+            },
+            "HIS": {
+                "explanation": "Heat Index Simplified: This indicator is a simpler version of the Heat Index, focusing on a quick estimate of perceived heat based on temperature and humidity.",
+                "input_data": ["2m temperature (t2m)", "2m dewpoint temperature (d2m)"]
+            },
+            "Tmean": {
+                "explanation": "Mean Temperature: This indicator calculates the average temperature over the specified period.",
+                "input_data": ["2m temperature (t2m)"]
+            },
+            "Tmin": {
+                "explanation": "Minimum Temperature: This indicator tracks the lowest temperature recorded over a specified period.",
+                "input_data": ["2m temperature (t2m)"]
+            },
+            "Tmax": {
+                "explanation": "Maximum Temperature: This indicator tracks the highest temperature recorded over a specified period.",
+                "input_data": ["2m temperature (t2m)"]
+            },
+            "HW": {
+                "explanation": "Heat Wave: This indicator identifies heat waves, defined as at least 3 consecutive days with temperatures exceeding a certain threshold.",
+                "input_data": ["2m temperature (t2m)"]
+            },
+            "TR": {
+                "explanation": "Tropical Nights: This indicator counts the number of nights where the minimum temperature remains above a certain threshold, typically 20°C.",
+                "input_data": ["2m temperature (t2m)"]
+            },
+            "HotDays": {
+                "explanation": "Hot Days: This indicator counts the number of days where the maximum temperature exceeds 30°C.",
+                "input_data": ["2m temperature (t2m)"]
+            }
+        }
+
+    def explain_index(self, tf_index):
+        """
+        Provides an explanation and input data for the selected index.
+
+        Parameters:
+        tf_index (str): The climate index identifier.
+
+        Returns:
+        str: A description of the selected index, its input data, or an error message if the index is invalid.
+        """
+        if tf_index in self.index_explanations:
+            explanation = f"Selected Index: {tf_index}\n"
+            explanation += f"Explanation: {self.index_explanations[tf_index]['explanation']}\n"
+            explanation += f"Input Data: {', '.join(self.index_explanations[tf_index]['input_data'])}"
+        else:
+            explanation = f"Error: {tf_index} is not a valid index. Please choose from {list(self.index_explanations.keys())}"
+
+        return explanation
+
+
     def calc_min_max_lead(self, year, month, leadtime_months=1):
         """
         Calculates the minimum and maximum lead time in hours for a given starting date.