the order is salinity then temperature in the tim file

Author: MAfarrag

hydrolib/tools/ext_old_to_new/converters.py

@@ -292,8 +292,8 @@ def parse_tim_model(
         The order of the quantities in the tim file should be as follows:
         - time
         - discharge
-        - temperaturedelta (optional)
         - salinitydelta (optional)
+        - temperaturedelta (optional)
         - initialtracer-anyname (optional)
         - any other quantities from the external forcings file.
 
@@ -340,8 +340,8 @@ def parse_tim_model(
             >>> print(time_series)
             {
                 "discharge": [1.0, 1.0, 1.0, 1.0, 1.0],
-                "temperaturedelta": [2.0, 2.0, 2.0, 2.0, 2.0],
-                "salinitydelta": [3.0, 3.0, 3.0, 3.0, 3.0],
+                "salinitydelta": [2.0, 2.0, 2.0, 2.0, 2.0],
+                "temperaturedelta": [3.0, 3.0, 3.0, 3.0, 3.0],
                 "initialtracer-anyname": [4.0, 4.0, 4.0, 4.0, 4.0],
             }
 

hydrolib/tools/ext_old_to_new/utils.py

@@ -241,12 +241,12 @@ def find_temperature_salinity_in_quantities(strings: List[str]) -> Dict[str, int
         strings (List[str]): A list of strings to search.
 
     Returns:
-        Dict[str, int]: A dictionary with keys as "temperature" or "salinity"
+        Dict[str, int]: A dictionary with keys as "salinity" or "temperature"
                         and values 3 and 4 respectively.
 
      Examples:
         >>> find_temperature_salinity_in_quantities(["temperature", "Salinity"])
-        OrderedDict({"temperaturedelta": 3, "salinitydelta": 4})
+        OrderedDict({"salinitydelta": 3, "temperaturedelta": 4})
 
         >>> find_temperature_salinity_in_quantities(["Temperature"])
         OrderedDict({"temperaturedelta": 3})
@@ -262,11 +262,11 @@ def find_temperature_salinity_in_quantities(strings: List[str]) -> Dict[str, int
     """
     result = OrderedDict()
 
-    if any("temperature" in string.lower() for string in strings):
-        result["temperaturedelta"] = 3
     if any("salinity" in string.lower() for string in strings):
-        result["salinitydelta"] = (
-            result.get("temperaturedelta", 2) + 1
+        result["salinitydelta"] = 3
+    if any("temperature" in string.lower() for string in strings):
+        result["temperaturedelta"] = (
+            result.get("salinitydelta", 2) + 1
         )  # Default temperature value is 2
 
     return result

tests/tools/test_converters_source_sink.py

@@ -25,8 +25,8 @@ def test_default(self):
 
         time_series_data = converter.parse_tim_model(tim_file, ext_file_quantity_list)
         assert time_series_data["discharge"] == [1.0, 1.0, 1.0, 1.0, 1.0]
-        assert time_series_data["temperaturedelta"] == [2.0, 2.0, 2.0, 2.0, 2.0]
-        assert time_series_data["salinitydelta"] == [3.0, 3.0, 3.0, 3.0, 3.0]
+        assert time_series_data["salinitydelta"] == [2.0, 2.0, 2.0, 2.0, 2.0]
+        assert time_series_data["temperaturedelta"] == [3.0, 3.0, 3.0, 3.0, 3.0]
         assert time_series_data["initialtracer_anyname"] == [4.0, 4.0, 4.0, 4.0, 4.0]
 
     def test_list_of_ext_quantities_tim_column_mismatch(self):
@@ -171,8 +171,8 @@ def test_default(self):
         converter.root_dir = "tests/data/input/source-sink"
         new_quantity_block = converter.convert(forcing, ext_file_other_quantities)
         assert new_quantity_block.initialtracer_anyname == [4.0, 4.0, 4.0, 4.0, 4.0]
-        assert new_quantity_block.salinitydelta == [3.0, 3.0, 3.0, 3.0, 3.0]
-        assert new_quantity_block.temperaturedelta == [2.0, 2.0, 2.0, 2.0, 2.0]
+        assert new_quantity_block.temperaturedelta == [3.0, 3.0, 3.0, 3.0, 3.0]
+        assert new_quantity_block.salinitydelta == [2.0, 2.0, 2.0, 2.0, 2.0]
         assert new_quantity_block.discharge == [1.0, 1.0, 1.0, 1.0, 1.0]
         assert new_quantity_block.zsink == [-4.2]
         assert new_quantity_block.zsource == [-3]
@@ -230,8 +230,8 @@ def test_4_5_columns_polyline(self):
         with patch("pathlib.Path.with_suffix", return_value=tim_file):
             new_quantity_block = converter.convert(forcing, ext_file_other_quantities)
         assert new_quantity_block.initialtracer_anyname == [4.0, 4.0, 4.0, 4.0, 4.0]
-        assert new_quantity_block.salinitydelta == [3.0, 3.0, 3.0, 3.0, 3.0]
-        assert new_quantity_block.temperaturedelta == [2.0, 2.0, 2.0, 2.0, 2.0]
+        assert new_quantity_block.temperaturedelta == [3.0, 3.0, 3.0, 3.0, 3.0]
+        assert new_quantity_block.salinitydelta == [2.0, 2.0, 2.0, 2.0, 2.0]
         assert new_quantity_block.discharge == [1.0, 1.0, 1.0, 1.0, 1.0]
         assert new_quantity_block.zsink == [-4.2, -5.35]
         assert new_quantity_block.zsource == [-3, -2.90]

tests/tools/test_tools_utils.py

@@ -41,11 +41,11 @@ def test_convert_interpolation_data():
 @pytest.mark.parametrize(
     "strings, expected",
     [
-        (["temperature", "Salinity"], {"temperaturedelta": 3, "salinitydelta": 4}),
+        (["temperature", "Salinity"], {"temperaturedelta": 4, "salinitydelta": 3}),
         (["Temperature"], {"temperaturedelta": 3}),
         (["Salinity"], {"salinitydelta": 3}),
         (["tracers"], {}),
-        (["TEMPERATURE", "salInity"], {"temperaturedelta": 3, "salinitydelta": 4}),
+        (["TEMPERATURE", "salInity"], {"temperaturedelta": 4, "salinitydelta": 3}),
         ([], {}),
         (["No relevant data here.", "Nothing to match."], {}),
     ],