add highs test for no type column

trevorb1 · Sep 28, 2024 · abe5446 · abe5446
1 parent a94a965
commit abe5446
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 7 deletions.
diff --git a/src/otoole/results/results.py b/src/otoole/results/results.py
@@ -298,10 +298,19 @@ def _convert_to_dataframe(self, file_path: Union[str, TextIO]) -> pd.DataFrame:
             index_col=0,
             dtype=str,
         )
+
+        # Type column is not garunteed in the the model output
+        # retain conditional as filtering on type is more explicit
+        if "Type" in df.columns:
+            var_types = ["Continuous", "Integer", "SemiContinuous", "SemiInteger"]
+            df = df[df.Type.isin(var_types)].copy()
+        else:
+            df = df.reset_index()
+            row = df[df.Index == "Rows"].index[0]
+            df = df.iloc[:row].set_index("Index")
+
         df.index.name = ""  # remove the name Index, as otoole uses that
 
-        var_types = ["Continuous", "Integer", "SemiContinuous", "SemiInteger"]
-        df = df[df.Type.isin(var_types)].copy()
         df[["Variable", "Index"]] = df["Name"].str.split("(", expand=True).loc[:, 0:1]
         df["Index"] = df["Index"].str.replace(")", "", regex=False)
         df = df[~(df.Primal.astype(float).abs() < 1e-6)]

diff --git a/tests/test_read_strategies.py b/tests/test_read_strategies.py
@@ -722,7 +722,7 @@ def test_read_model_error(self, user_config):
 class TestReadHighs:
     """Tests reading of HiGHS solution file"""
 
-    highs_data = dedent(
+    highs_data_with_type_col = dedent(
         """Columns
     Index Status        Lower        Upper       Primal         Dual  Type        Name
         0     BS            0          inf      193.604            0  Continuous  TotalDiscountedCost(SIMPLICITY,2014)
@@ -755,10 +755,45 @@ class TestReadHighs:
 """
     )
 
-    def test_convert_to_dataframe(self, user_config):
-        input_file = self.highs_data
+    highs_data_no_type_col = dedent(
+        """Columns
+    Index Status        Lower        Upper       Primal         Dual  Name
+        0     BS            0          inf      193.604            0  TotalDiscountedCost(SIMPLICITY,2014)
+        1     BS            0          inf      187.724            0  TotalDiscountedCost(SIMPLICITY,2015)
+        2     BS            0          inf      183.998            0  TotalDiscountedCost(SIMPLICITY,2016)
+        3     BS            0          inf      181.728            0  TotalDiscountedCost(SIMPLICITY,2017)
+     2433     LB            0          inf            0       162680  RateOfActivity(SIMPLICITY,ID,BACKSTOP1,1,2014)
+     2434     LB            0          inf            0       162682  RateOfActivity(SIMPLICITY,ID,BACKSTOP1,2,2014)
+     2435     BS            0          inf           -0            0  RateOfTotalActivity(SIMPLICITY,BACKSTOP1,ID,2014)
+     2436     LB            0          inf            0       154933  RateOfActivity(SIMPLICITY,ID,BACKSTOP1,1,2015)
+     5772     BS            0          inf     0.353203            0  RateOfActivity(SIMPLICITY,WN,HYD1,1,2020)
+     5773     LB            0          inf            0      2.15221  RateOfActivity(SIMPLICITY,WN,HYD1,2,2020)
+     5774     BS            0          inf     0.353203            0  RateOfTotalActivity(SIMPLICITY,HYD1,WN,2020)
+     5775     BS            0          inf     0.353203            0  RateOfActivity(SIMPLICITY,WN,HYD1,1,2021)
+    15417     BS            0          inf           -0            0  RateOfProductionByTechnologyByMode(SIMPLICITY,ID,GAS_IMPORT,1,GAS,2038)
+    15418     BS            0          inf           -0            0  RateOfProductionByTechnologyByMode(SIMPLICITY,ID,GAS_IMPORT,1,GAS,2039)
+    15419     BS            0          inf           -0            0  RateOfProductionByTechnologyByMode(SIMPLICITY,ID,GAS_IMPORT,1,GAS,2040)
+Rows
+    Index Status        Lower        Upper       Primal         Dual  Name
+        0     FX     -1.59376     -1.59376     -1.59376     -2.68632  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2014)
+        1     FX     -1.60168     -1.60168     -1.60168      -2.5584  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2015)
+        2     FX     -1.63695     -1.63695     -1.63695     -2.43657  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2016)
+        3     FX      -1.6859      -1.6859      -1.6859     -2.32054  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2017)
+        4     FX     -1.74637     -1.74637     -1.74637     -2.21004  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2018)
+        5     FX     -1.80612     -1.80612     -1.80612      -2.1048  EQ_SpecifiedDemand(SIMPLICITY,ID,FEL1,2019)
+
+Model status: Optimal
+
+Objective value: 4497.319670152045
+"""
+    )
+
+    test_data = [highs_data_with_type_col, highs_data_no_type_col]
+
+    @mark.parametrize("highs_sol", test_data, ids=["with_type_col", "no_type_col"])
+    def test_convert_to_dataframe(self, user_config, highs_sol):
         reader = ReadHighs(user_config)
-        with StringIO(input_file) as file_buffer:
+        with StringIO(highs_sol) as file_buffer:
             actual = reader._convert_to_dataframe(file_buffer)
         expected = pd.DataFrame(
             [
@@ -776,7 +811,7 @@ def test_convert_to_dataframe(self, user_config):
         pd.testing.assert_frame_equal(actual, expected)
 
     def test_solution_to_dataframe(self, user_config):
-        input_file = self.highs_data
+        input_file = self.highs_data_with_type_col
         reader = ReadHighs(user_config)
         with StringIO(input_file) as file_buffer:
             actual = reader.read(file_buffer)