Check that utilisation factors are in range

Author: alexdewar

src/muse/readers/csv.py

@@ -930,6 +930,7 @@ def check_utilization_and_minimum_service_factors(data, filename):
         )
 
     _check_utilization_not_all_zero(data, filename)
+    _check_utilization_in_range(data, filename)
     _check_minimum_service_factors_in_range(data, filename)
 
 
@@ -943,6 +944,15 @@ def _check_utilization_not_all_zero(data, filename):
         )
 
 
+def _check_utilization_in_range(data, filename):
+    utilization = data["utilization_factor"]
+    if not np.all((0 <= utilization) & (utilization <= 1)):
+        raise ValueError(
+            f"""Utilization factor values must all be between 0 and 1 inclusive.
+            Please check file {filename}."""
+        )
+
+
 def _check_minimum_service_factors_in_range(data, filename):
     try:
         min_service_factor = data["minimum_service_factor"]

tests/test_readers.py

@@ -429,6 +429,26 @@ def test_check_utilization_not_all_zero_success():
     _check_utilization_not_all_zero(df, "file.csv")
 
 
+def test_check_utilization_in_range_success():
+    import pandas as pd
+    from muse.readers.csv import _check_utilization_in_range
+
+    df = pd.DataFrame({"utilization_factor": (0, 1)})
+    _check_utilization_in_range(df, "file.csv")
+
+
+@mark.parametrize(
+    "values", chain.from_iterable(permutations((0, bad)) for bad in (-1, 2))
+)
+def test_check_utilization_in_range_fail(values):
+    import pandas as pd
+    from muse.readers.csv import _check_utilization_in_range
+
+    df = pd.DataFrame({"utilization_factor": values})
+    with raises(ValueError):
+        _check_utilization_in_range(df, "file.csv")
+
+
 def test_check_utilization_not_all_zero_fail_all_zero():
     import pandas as pd
     from muse.readers.csv import _check_utilization_not_all_zero
@@ -478,6 +498,7 @@ def test_check_minimum_service_factors_in_range_fail(values):
 
 
 @patch("muse.readers.csv._check_minimum_service_factors_in_range")
+@patch("muse.readers.csv._check_utilization_in_range")
 @patch("muse.readers.csv._check_utilization_not_all_zero")
 def test_check_utilization_and_minimum_service_factors(*mocks):
     import pandas as pd
@@ -490,6 +511,7 @@ def test_check_utilization_and_minimum_service_factors(*mocks):
 
 
 @patch("muse.readers.csv._check_minimum_service_factors_in_range")
+@patch("muse.readers.csv._check_utilization_in_range")
 @patch("muse.readers.csv._check_utilization_not_all_zero")
 def test_check_utilization_and_minimum_service_factors_missing_column(*mocks):
     import pandas as pd