ltbams 0.9.9__py3-none-any.whl → 1.0.0__py3-none-any.whl

tests/test_report.py

@@ -0,0 +1,245 @@
+"""
+Test system report.
+"""
+import unittest
+import os
+
+import ams
+
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class TestReport(unittest.TestCase):
+    """
+    Tests for Report class.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.main.load(
+            ams.get_case("5bus/pjm5bus_demo.xlsx"),
+            default_config=True,
+            no_output=True,
+        )
+        self.expected_report = 'pjm5bus_demo_out.txt'
+
+    def test_no_output(self):
+        """
+        Test no output.
+        """
+        self.assertTrue(self.ss.files.no_output)
+        self.assertFalse(self.ss.report())
+
+    def test_no_report(self):
+        """
+        Test report with no solved routine.
+        """
+        self.ss.files.no_output = False
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertNotIn("DCOPF", file_contents)
+
+        os.remove(self.expected_report)
+
+    def test_DCOPF_report(self):
+        """
+        Test report with DCOPF solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("DCOPF", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.DCOPF.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_DCOPF.csv'))
+        os.remove('pjm5bus_demo_DCOPF.csv')
+
+    def test_DCPF_report(self):
+        """
+        Test report with DCPF solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.DCPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("DCPF", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.DCPF.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_DCPF.csv'))
+        os.remove('pjm5bus_demo_DCPF.csv')
+
+    def test_RTED_report(self):
+        """
+        Test report with RTED solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.RTED.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("RTED", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.RTED.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_RTED.csv'))
+        os.remove('pjm5bus_demo_RTED.csv')
+
+    def test_RTEDDG_report(self):
+        """
+        Test report with RTEDDG solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.RTEDDG.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("RTEDDG", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.RTEDDG.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_RTEDDG.csv'))
+        os.remove('pjm5bus_demo_RTEDDG.csv')
+
+    def test_RTEDES_report(self):
+        """
+        Test report with RTEDES solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.RTEDES.run(solver='SCIP')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("RTEDES", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.RTEDES.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_RTEDES.csv'))
+        os.remove('pjm5bus_demo_RTEDES.csv')
+
+    def test_ED_report(self):
+        """
+        Test report with ED solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.ED.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("ED", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.ED.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_ED.csv'))
+        os.remove('pjm5bus_demo_ED.csv')
+
+    def test_EDDG_report(self):
+        """
+        Test report with EDDG solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.EDDG.run(solver='CLARABEL')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("EDDG", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.EDDG.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_EDDG.csv'))
+        os.remove('pjm5bus_demo_EDDG.csv')
+
+    def test_EDES_report(self):
+        """
+        Test report with EDES solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.EDES.run(solver='SCIP')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("EDES", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.EDES.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_EDES.csv'))
+        os.remove('pjm5bus_demo_EDES.csv')
+
+    def test_UC_report(self):
+        """
+        Test report with UC solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.UC.run(solver='SCIP')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("UC", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.UC.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_UC.csv'))
+        os.remove('pjm5bus_demo_UC.csv')
+
+    def test_UCDG_report(self):
+        """
+        Test report with UCDG solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.UCDG.run(solver='SCIP')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("UCDG", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.UCDG.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_UCDG.csv'))
+        os.remove('pjm5bus_demo_UCDG.csv')
+
+    def test_UCES_report(self):
+        """
+        Test report with UCES solved.
+        """
+        self.ss.files.no_output = False
+        self.ss.UCES.run(solver='SCIP')
+        self.assertTrue(self.ss.report())
+        self.assertTrue(os.path.exists(self.expected_report))
+
+        with open(self.expected_report, "r") as report_file:
+            file_contents = report_file.read()
+            self.assertIn("UCES", file_contents)
+        os.remove(self.expected_report)
+
+        self.ss.UCES.export_csv()
+        self.assertTrue(os.path.exists('pjm5bus_demo_UCES.csv'))
+        os.remove('pjm5bus_demo_UCES.csv')

tests/test_repr.py

@@ -0,0 +1,21 @@
+import contextlib
+import unittest
+
+import ams
+
+
+class TestRepr(unittest.TestCase):
+    """Test __repr__"""
+    def setUp(self):
+        self.ss = ams.run(ams.get_case("ieee39/ieee39_uced.xlsx"),
+                          no_output=True,
+                          default_config=True,
+                          )
+
+    def test_print_model_repr(self):
+        """
+        Print out Model ``cache``'s fields and values.
+        """
+        with contextlib.redirect_stdout(None):
+            for model in self.ss.models.values():
+                print(model.cache.__dict__)

tests/test_routine.py

@@ -0,0 +1,178 @@
+import unittest
+import numpy as np
+
+
+import ams
+from ams.shared import pd
+
+
+class TestRoutineMethods(unittest.TestCase):
+    """
+    Test methods of `Routine`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("ieee39/ieee39_uced.xlsx"),
+                           default_config=True,
+                           no_output=True,
+                           )
+
+    def test_data_check(self):
+        """
+        Test `Routine._data_check()` method.
+        """
+
+        self.assertTrue(self.ss.DCOPF._data_check())
+        self.assertFalse(self.ss.RTEDES._data_check())
+
+    def test_get_off_constrs(self):
+        """
+        Test `Routine._get_off_constrs()` method.
+        """
+
+        self.assertIsInstance(self.ss.DCOPF._get_off_constrs(), list)
+
+    def test_routine_set(self):
+        """
+        Test `Routine.set()` method.
+        """
+
+        self.ss.DCOPF.set('c2', 'GCost_1', 'v', 10)
+        np.testing.assert_equal(self.ss.GCost.get('c2', 'GCost_1', 'v'), 10)
+
+    def test_routine_get(self):
+        """
+        Test `Routine.get()` method.
+        """
+        # --- single period routine ---
+        # get an rparam value
+        np.testing.assert_equal(self.ss.DCOPF.get('ug', 'PV_30'), 1)
+
+        # get an unpacked var value
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.assertEqual(self.ss.DCOPF.exit_code, 0, "Exit code is not 0.")
+        np.testing.assert_equal(self.ss.DCOPF.get('pg', 'PV_30', 'v'),
+                                self.ss.StaticGen.get('p', 'PV_30', 'v'))
+
+        # test input type
+        self.assertIsInstance(self.ss.DCOPF.get('pg', pd.Series(['PV_30']), 'v'), np.ndarray)
+
+        # test return type
+        self.assertIsInstance(self.ss.DCOPF.get('pg', 'PV_30', 'v'), float)
+        self.assertIsInstance(self.ss.DCOPF.get('pg', ['PV_30'], 'v'), np.ndarray)
+
+        # --- multi period routine ---
+        self.ss.ED.run(solver='CLARABEL')
+        self.assertEqual(self.ss.ED.exit_code, 0, "Exit code is not 0.")
+        np.testing.assert_equal(self.ss.ED.get('pg', 'PV_30', 'v').ndim, 1)
+        np.testing.assert_equal(self.ss.ED.get('pg', ['PV_30'], 'v').ndim, 2)
+
+    def test_rouine_init(self):
+        """
+        Test `Routine.init()` method.
+        """
+
+        self.assertTrue(self.ss.DCOPF.init(), "DCOPF initialization failed!")
+
+    def test_generate_symbols(self):
+        """
+        Test symbol generation.
+        """
+
+        self.ss.DCOPF.syms.generate_symbols()
+        self.assertTrue(self.ss.DCOPF._syms, "Symbol generation failed!")
+
+    def test_value_method(self):
+        """
+        Test Contraint and Objective values.
+        """
+
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.DCOPF.converged, "DCOPF did not converge!")
+
+        # --- constraint values ---
+        for constr in self.ss.DCOPF.constrs.values():
+            np.testing.assert_almost_equal(constr.v, constr.e, decimal=6)
+
+        # --- objective value ---
+        self.assertAlmostEqual(self.ss.DCOPF.obj.v, self.ss.DCOPF.obj.e, places=6)
+
+
+class TestSetOptzValueACOPF(unittest.TestCase):
+    """
+    Test value settings of `OptzBase` series in `ACOPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("5bus/pjm5bus_demo.xlsx"),
+                           setup=True,
+                           default_config=True,
+                           no_output=True,
+                           )
+
+    def test_vset_before_init(self):
+        """
+        Test value setting before routine initialization.
+        """
+        # set values to `Var` before initialization is not doable
+        v_ext = np.ones(self.ss.ACOPF.pg.n)
+        self.ss.ACOPF.pg.v = v_ext
+        self.assertIsNone(self.ss.ACOPF.pg.v)
+        # set values to `Constraint` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.ACOPF.plfub, 'v', 1))
+        # set values to `Objective` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.ACOPF.obj, 'v', 1))
+
+    def test_vset_after_init(self):
+        """
+        Test value setting after routine initialization.
+        """
+        self.ss.ACOPF.init()
+        # set values to `Var` after initialization is allowed
+        v_ext = np.ones(self.ss.ACOPF.pg.n)
+        self.ss.ACOPF.pg.v = v_ext
+        np.testing.assert_equal(self.ss.ACOPF.pg.v, v_ext)
+        # set values to `Constraint` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.ACOPF.plfub, 'v', 1))
+        # set values to `Objective` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.ACOPF.obj, 'v', 1))
+
+
+class TestSetOptzValueDCOPF(unittest.TestCase):
+    """
+    Test value settings of `OptzBase` series in `DCOPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("5bus/pjm5bus_demo.xlsx"),
+                           setup=True,
+                           default_config=True,
+                           no_output=True,
+                           )
+
+    def test_vset_before_init(self):
+        """
+        Test value setting before routine initialization.
+        """
+        # set values to `Var` before initialization is not doable
+        v_ext = np.ones(self.ss.DCOPF.pg.n)
+        self.ss.DCOPF.pg.v = v_ext
+        self.assertIsNone(self.ss.DCOPF.pg.v)
+        # set values to `Constraint` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.DCOPF.plfub, 'v', 1))
+        # set values to `Objective` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.DCOPF.obj, 'v', 1))
+
+    def test_vset_after_init(self):
+        """
+        Test value setting after routine initialization.
+        """
+        self.ss.DCOPF.init()
+        # set values to `Var` after initialization is allowed
+        v_ext = np.ones(self.ss.DCOPF.pg.n)
+        self.ss.DCOPF.pg.v = v_ext
+        np.testing.assert_equal(self.ss.DCOPF.pg.v, v_ext)
+        # set values to `Constraint` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.DCOPF.plfub, 'v', 1))
+        # set values to `Objective` is not allowed
+        self.assertRaises(AttributeError, lambda: setattr(self.ss.DCOPF.obj, 'v', 1))

tests/test_rtn_dcopf.py

@@ -0,0 +1,101 @@
+import unittest
+import numpy as np
+
+import ams
+
+
+class TestDCOPF(unittest.TestCase):
+    """
+    Test routine `DCOPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("5bus/pjm5bus_demo.xlsx"),
+                           setup=True, default_config=True, no_output=True)
+        # decrease load first
+        self.ss.PQ.set(src='p0', attr='v', idx=['PQ_1', 'PQ_2'], value=[0.3, 0.3])
+
+    def test_init(self):
+        """
+        Test initialization.
+        """
+        self.ss.DCOPF.init()
+        self.assertTrue(self.ss.DCOPF.initialized, "DCOPF initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        stg = 'PV_1'
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+
+        self.ss.DCOPF.update()
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.DCOPF.converged, "DCOPF did not converge under generator trip!")
+        self.assertAlmostEqual(self.ss.DCOPF.get(src='pg', attr='v', idx=stg),
+                               0, places=6,
+                               msg="Generator trip does not take effect!")
+
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=1)  # reset
+
+    def test_trip_line(self):
+        """
+        Test line tripping.
+        """
+        self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
+
+        self.ss.DCOPF.update()
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.DCOPF.converged, "DCOPF did not converge under line trip!")
+        self.assertAlmostEqual(self.ss.DCOPF.get(src='plf', attr='v', idx='Line_3'),
+                               0, places=6,
+                               msg="Line trip does not take effect!")
+
+        self.ss.Line.alter(src='u', idx='Line_3', value=1)  # reset
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        # --- run DCOPF ---
+        self.ss.DCOPF.run(solver='CLARABEL')
+        pgs = self.ss.DCOPF.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.DCOPF.update()
+
+        self.ss.DCOPF.run(solver='CLARABEL')
+        pgs_pqt = self.ss.DCOPF.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.set(src='u', attr='v', idx='PQ_2', value=0)
+        self.ss.DCOPF.update()
+
+        self.ss.DCOPF.run(solver='CLARABEL')
+        pgs_pqt2 = self.ss.DCOPF.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
+
+    def test_dc2ac(self):
+        """
+        Test `DCOPF.dc2ac()` method.
+        """
+        self.ss.DCOPF.run(solver='CLARABEL')
+        self.ss.DCOPF.dc2ac()
+        self.assertTrue(self.ss.DCOPF.converted, "AC conversion failed!")
+        self.assertTrue(self.ss.DCOPF.exec_time > 0, "Execution time is not greater than 0.")
+
+        stg_idx = self.ss.StaticGen.get_all_idxes()
+        pg_dcopf = self.ss.DCOPF.get(src='pg', attr='v', idx=stg_idx)
+        pg_acopf = self.ss.ACOPF.get(src='pg', attr='v', idx=stg_idx)
+        np.testing.assert_almost_equal(pg_dcopf, pg_acopf, decimal=3)
+
+        bus_idx = self.ss.Bus.get_all_idxes()
+        v_dcopf = self.ss.DCOPF.get(src='vBus', attr='v', idx=bus_idx)
+        v_acopf = self.ss.ACOPF.get(src='vBus', attr='v', idx=bus_idx)
+        np.testing.assert_almost_equal(v_dcopf, v_acopf, decimal=3)
+
+        a_dcopf = self.ss.DCOPF.get(src='aBus', attr='v', idx=bus_idx)
+        a_acopf = self.ss.ACOPF.get(src='aBus', attr='v', idx=bus_idx)
+        np.testing.assert_almost_equal(a_dcopf, a_acopf, decimal=3)

tests/test_rtn_dcpf.py

@@ -0,0 +1,77 @@
+import unittest
+
+import ams
+
+
+class TestDCPF(unittest.TestCase):
+    """
+    Test routine `DCPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("5bus/pjm5bus_demo.xlsx"),
+                           setup=True, default_config=True, no_output=True)
+        # decrease load first
+        self.ss.PQ.set(src='p0', attr='v', idx=['PQ_1', 'PQ_2'], value=[0.3, 0.3])
+
+    def test_init(self):
+        """
+        Test initialization.
+        """
+        self.ss.DCPF.init()
+        self.assertTrue(self.ss.DCPF.initialized, "DCPF initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        stg = 'PV_1'
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+
+        self.ss.DCPF.update()
+        self.ss.DCPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.DCPF.converged, "DCPF did not converge under generator trip!")
+        self.assertAlmostEqual(self.ss.DCPF.get(src='pg', attr='v', idx=stg),
+                               0, places=6,
+                               msg="Generator trip does not take effect!")
+
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=1)  # reset
+
+    def test_trip_line(self):
+        """
+        Test line tripping.
+        """
+        self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
+
+        self.ss.DCPF.update()
+        self.ss.DCPF.run(solver='CLARABEL')
+        self.assertTrue(self.ss.DCPF.converged, "DCPF did not converge under line trip!")
+        self.assertAlmostEqual(self.ss.DCPF.get(src='plf', attr='v', idx='Line_3'),
+                               0, places=6,
+                               msg="Line trip does not take effect!")
+
+        self.ss.Line.alter(src='u', idx='Line_3', value=1)  # reset
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        # --- run DCPF ---
+        self.ss.DCPF.run(solver='CLARABEL')
+        pgs = self.ss.DCPF.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.DCPF.update()
+
+        self.ss.DCPF.run(solver='CLARABEL')
+        pgs_pqt = self.ss.DCPF.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.set(src='u', attr='v', idx='PQ_2', value=0)
+        self.ss.DCPF.update()
+
+        self.ss.DCPF.run(solver='CLARABEL')
+        pgs_pqt2 = self.ss.DCPF.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")