Add time dependant VariableAxis to CSV

Author: RichardHitier

speasy/core/codecs/bundled_codecs/hapi_csv/codec.py

@@ -18,6 +18,12 @@
 from .writer import save_hapi_csv
 
 
+def _time_dependent_axis_name(ax: VariableAxis) -> str:
+    return f"{ax.name}_centers_time_varying"
+
+def _get_variable_axes(variable: SpeasyVariable, is_time_dependent: bool) -> List[VariableAxis]:
+    return [ax for ax in variable.axes[1:] if ax.is_time_dependent == is_time_dependent]
+
 def _create_meta(variable:SpeasyVariable) -> Dict[str, Any]:
     meta = {
         "name": variable.name,
@@ -44,12 +50,23 @@ def _create_meta(variable:SpeasyVariable) -> Dict[str, Any]:
     if  len(variable.values.shape) > 1:
         meta["size"] = variable.values.shape[1:]
 
-    time_independent_axes = [ax for ax in variable.axes[1:] if not ax.is_time_dependent]
+    bins = []
+    time_independent_axes = _get_variable_axes(variable, is_time_dependent=False)
     if time_independent_axes:
-        meta["bins"] = [
-            {"name": ax.name, "units": ax.unit, "centers": ax.values.tolist()}
+        bins.extend([
+            {"name": ax.name, "unit": ax.unit, "centers": ax.values.tolist()}
             for ax in time_independent_axes
-        ]
+        ])
+
+    time_dependent_axes = _get_variable_axes(variable, is_time_dependent=True)
+    if time_dependent_axes:
+        bins.extend([
+            {"name": ax.name, "unit": ax.unit, "centers": _time_dependent_axis_name(ax)}
+            for ax in time_dependent_axes
+        ])
+
+    if bins:
+        meta["bins"] = bins
 
     return meta
 
@@ -67,8 +84,9 @@ def _bin_to_axis(json_bin: Dict[str, Any], hap_csv_file: HapiCsvFile) -> Variabl
         raise ValueError("Invalid bin specification: missing 'centers' field")
     if isinstance(centers, str):
         hapi_parameter = hap_csv_file.get_parameter(centers)
+        _meta = _decode_meta(hapi_parameter.meta)
         variable_axis = VariableAxis(values=hapi_parameter.values,
-                                     meta=hapi_parameter.meta,
+                                     meta=_meta,
                                      is_time_dependent=True,
                                      name=name)
     elif isinstance(centers, list):
@@ -77,7 +95,7 @@ def _bin_to_axis(json_bin: Dict[str, Any], hap_csv_file: HapiCsvFile) -> Variabl
         except ValueError:
             raise ValueError("Invalid bin specification: 'centers' list must contain numeric values")
         variable_axis = VariableAxis(values=axis_values,
-                                     meta={"name": "centers"},
+                                     meta={"name": "centers", "UNITS": json_bin.get("units", None)},
                                      is_time_dependent=False,
                                      name=name)
     else:
@@ -122,6 +140,18 @@ def _make_hapi_csv_time_axis(time_axis: VariableTimeAxis) -> HapiCsvParameter:
     return HapiCsvParameter(values=time_axis.values,
                             meta={"name": "Time", "type": "isotime", "units": "UTC", "length": 30, "fill": None})
 
+def _get_hapi_csv_varying_axes(variable: SpeasyVariable) -> List[HapiCsvParameter]:
+    result = []
+    for ax in _get_variable_axes(variable, is_time_dependent=True):
+        meta = {
+            "name": _time_dependent_axis_name(ax),
+            "type": "double",
+            "units": ax.unit,
+            "size": [ax.values.shape[1]]
+        }
+        result.append(HapiCsvParameter(values=ax.values, meta=meta))
+    return result
+
 
 def _speasy_variables_to_hapi_csv(variables: List[SpeasyVariable]) -> HapiCsvFile:
     if not same_time_axis(variables):
@@ -132,6 +162,8 @@ def _speasy_variables_to_hapi_csv(variables: List[SpeasyVariable]) -> HapiCsvFil
     hapi_csv_file.add_parameter(_make_hapi_csv_time_axis(variables[0].axes[0]))
     for var in variables:
         hapi_csv_file.add_parameter(_make_hapi_csv_parameter(var))
+        for hapi_axis_parameter in _get_hapi_csv_varying_axes(var):
+            hapi_csv_file.add_parameter(hapi_axis_parameter) 
     return hapi_csv_file
 
 

tests/resources/HAPI_ndData_TimeVarying_Axis.csv

@@ -66,4 +66,4 @@
 #}
 
 1970-01-01T00:00:00.000Z,0,1,0.5,0.3333333333333333,0.25,0.2,0.16666666666666666,0.14285714285714285,0.125,0.1111111111111111,11,13,15,17,19,21,23,25,27,29,10,12,12,14,14,16,16,18,18,20,20,22,22,24,24,26,26,28,28,30
-1970-01-01T00:00:01.000Z,0,1,0.5,0.3333333333333333,0.25,0.2,0.16666666666666666,0.14285714285714285,0.125,0.1111111111111111,11,13,15,17,19,21,23,25,27,29,10,12,12,14,14,16,16,18,18,20,20,22,22,24,24,26,26,28,28,30
+1970-01-01T00:01:08.000Z,0,1,0.5,0.3333333333333333,0.25,0.2,0.16666666666666666,0.14285714285714285,0.125,0.1111111111111111,1,3,5,7,9,11,13,15,17,19

tests/test_hapi_codecs.py

@@ -153,7 +153,7 @@ def test_speasy_to_csv(self):
             self.assertListEqual(var_names, csv_names)
 
 
-    def test_time_independant_axis_to_csv(self):
+    def test_time_independent_axis_to_csv(self):
         hapi_csv_codec: CodecInterface = get_codec('hapi/csv')
         with open(os.path.join(__HERE__, 'resources', 'HAPI_ndData_TimeIndependent_Axis.csv'), 'r') as f:
             variables = hapi_csv_codec.load_variables(file=f, variables=['ace_epam_de_e'], disable_cache=True)
@@ -164,3 +164,13 @@ def test_time_independant_axis_to_csv(self):
             self.assertTrue(hapi_csv_file)
             self.assertTrue(os.path.exists(output_csv_file))
 
+    def test_time_varying_axis_to_csv(self):
+        hapi_csv_codec: CodecInterface = get_codec('hapi/csv')
+        with open(os.path.join(__HERE__, 'resources', 'HAPI_ndData_TimeVarying_Axis.csv'), 'r') as f:
+            variables = hapi_csv_codec.load_variables(file=f, variables=['spectra_time_dependent_bins'], disable_cache=True)
+            self.assertIn('spectra_time_dependent_bins', variables)
+        with tempfile.NamedTemporaryFile(suffix='.csv', delete=True) as tmp:
+            output_csv_file = tmp.name
+            hapi_csv_file = hapi_csv_codec.save_variables(variables=list(variables.values()), file=output_csv_file)
+            self.assertTrue(hapi_csv_file)
+            self.assertTrue(os.path.exists(output_csv_file))