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

tests/test_rtn_ed.py

@@ -0,0 +1,275 @@
+import unittest
+import numpy as np
+
+import ams
+
+
+class TestED(unittest.TestCase):
+    """
+    Test routine `ED`.
+    """
+
+    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.ED.init()
+        self.assertTrue(self.ss.ED.initialized, "ED initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        # a) ensure EDTSlot.ug takes effect
+        # NOTE: manually chang ug.v for testing purpose
+        stg = 'PV_1'
+        stg_uid = self.ss.ED.pg.get_all_idxes().index(stg)
+        loc_offtime = np.array([0, 2, 4])
+        self.ss.EDTSlot.ug.v[loc_offtime, stg_uid] = 0
+
+        self.ss.ED.run(solver='CLARABEL')
+        self.assertTrue(self.ss.ED.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.ED.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_almost_equal(np.zeros_like(loc_offtime),
+                                       pg_pv1[loc_offtime],
+                                       decimal=6,
+                                       err_msg="Generator trip does not take effect!")
+
+        self.ss.EDTSlot.ug.v[...] = 1  # reset
+
+        # b) ensure StaticGen.u does not take effect
+        # NOTE: in ED, `EDTSlot.ug` is used instead of `StaticGen.u`
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+        self.ss.ED.update()
+
+        self.ss.ED.run(solver='CLARABEL')
+        self.assertTrue(self.ss.ED.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.ED.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_array_less(np.zeros_like(pg_pv1), pg_pv1,
+                                     err_msg="Generator trip take effect, which is unexpected!")
+
+        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.ED.update()
+
+        self.ss.ED.run(solver='CLARABEL')
+        self.assertTrue(self.ss.ED.converged, "ED did not converge under line trip!")
+        plf_l3 = self.ss.ED.get(src='plf', attr='v', idx='Line_3')
+        np.testing.assert_almost_equal(np.zeros_like(plf_l3),
+                                       plf_l3, decimal=6)
+
+        self.ss.Line.alter(src='u', idx='Line_3', value=1)  # reset
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        self.ss.ED.run(solver='CLARABEL')
+        pgs = self.ss.ED.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.ED.update()
+
+        self.ss.ED.run(solver='CLARABEL')
+        pgs_pqt = self.ss.ED.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
+        self.ss.ED.update()
+
+        self.ss.ED.run(solver='CLARABEL')
+        pgs_pqt2 = self.ss.ED.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
+
+
+class TestEDDG(unittest.TestCase):
+    """
+    Test routine `EDDG`.
+    """
+
+    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.EDDG.init()
+        self.assertTrue(self.ss.EDDG.initialized, "EDDG initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        # a) ensure EDTSlot.ug takes effect
+        # NOTE: manually chang ug.v for testing purpose
+        stg = 'PV_1'
+        stg_uid = self.ss.EDDG.pg.get_all_idxes().index(stg)
+        loc_offtime = np.array([0, 2, 4])
+        self.ss.EDTSlot.ug.v[loc_offtime, stg_uid] = 0
+
+        self.ss.EDDG.run(solver='CLARABEL')
+        self.assertTrue(self.ss.EDDG.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.EDDG.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_almost_equal(np.zeros_like(loc_offtime),
+                                       pg_pv1[loc_offtime],
+                                       decimal=6,
+                                       err_msg="Generator trip does not take effect!")
+
+        self.ss.EDTSlot.ug.v[...] = 1
+
+        # b) ensure StaticGen.u does not take effect
+        # NOTE: in EDDG, `EDTSlot.ug` is used instead of `StaticGen.u`
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+        self.ss.EDDG.update()
+
+        self.ss.EDDG.run(solver='CLARABEL')
+        self.assertTrue(self.ss.EDDG.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.EDDG.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_array_less(np.zeros_like(pg_pv1), pg_pv1,
+                                     err_msg="Generator trip take effect, which is unexpected!")
+
+        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.EDDG.update()
+
+        self.ss.EDDG.run(solver='CLARABEL')
+        self.assertTrue(self.ss.EDDG.converged, "ED did not converge under line trip!")
+        plf_l3 = self.ss.EDDG.get(src='plf', attr='v', idx='Line_3')
+        np.testing.assert_almost_equal(np.zeros_like(plf_l3),
+                                       plf_l3, decimal=6)
+
+        self.ss.Line.alter(src='u', idx='Line_3', value=1)
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        self.ss.EDDG.run(solver='CLARABEL')
+        pgs = self.ss.EDDG.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.EDDG.update()
+
+        self.ss.EDDG.run(solver='CLARABEL')
+        pgs_pqt = self.ss.EDDG.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
+        self.ss.EDDG.update()
+
+        self.ss.EDDG.run(solver='CLARABEL')
+        pgs_pqt2 = self.ss.EDDG.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
+
+
+class TestEDES(unittest.TestCase):
+    """
+    Test routine `EDES`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case("5bus/pjm5bus_uced_esd1.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.EDES.init()
+        self.assertTrue(self.ss.EDES.initialized, "EDES initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        # a) ensure EDTSlot.ug takes effect
+        # NOTE: manually chang ug.v for testing purpose
+        stg = 'PV_1'
+        stg_uid = self.ss.EDES.pg.get_all_idxes().index(stg)
+        loc_offtime = np.array([0, 2])
+        self.ss.EDTSlot.ug.v[loc_offtime, stg_uid] = 0
+
+        self.ss.EDES.run(solver='SCIP')
+        self.assertTrue(self.ss.EDES.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.EDES.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_almost_equal(np.zeros_like(loc_offtime),
+                                       pg_pv1[loc_offtime],
+                                       decimal=6,
+                                       err_msg="Generator trip does not take effect!")
+
+        self.ss.EDTSlot.ug.v[...] = 1  # reset
+
+        # b) ensure StaticGen.u does not take effect
+        # NOTE: in ED, `EDTSlot.ug` is used instead of `StaticGen.u`
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+        self.ss.EDES.update()
+
+        self.ss.EDES.run(solver='SCIP')
+        self.assertTrue(self.ss.EDES.converged, "ED did not converge under generator trip!")
+        pg_pv1 = self.ss.EDES.get(src='pg', attr='v', idx=stg)
+        np.testing.assert_array_less(np.zeros_like(pg_pv1), pg_pv1,
+                                     err_msg="Generator trip take effect, which is unexpected!")
+
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=1)  # reset
+
+    def test_line_trip(self):
+        """
+        Test line tripping.
+        """
+        self.ss.Line.set(src='u', attr='v', idx=3, value=0)
+        self.ss.EDES.run(solver='SCIP')
+        self.assertTrue(self.ss.EDES.converged, "EDES did not converge!")
+        plf_l3 = self.ss.EDES.get(src='plf', attr='v', idx=3)
+        np.testing.assert_almost_equal(np.zeros_like(plf_l3),
+                                       plf_l3, decimal=6)
+
+        self.ss.Line.alter(src='u', idx=3, value=1)
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        self.ss.EDES.run(solver='SCIP')
+        pgs = self.ss.EDES.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.EDES.update()
+
+        self.ss.EDES.run(solver='SCIP')
+        pgs_pqt = self.ss.EDES.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
+        self.ss.EDES.update()
+
+        self.ss.EDES.run(solver='SCIP')
+        pgs_pqt2 = self.ss.EDES.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")

tests/test_rtn_pflow.py

@@ -0,0 +1,219 @@
+import unittest
+
+import ams
+
+
+class TestDCPF(unittest.TestCase):
+    """
+    Test routine `DCPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case('matpower/case14.m'),
+                           setup=True, no_output=True, default_config=True)
+
+    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 = 2
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+
+        self.ss.DCPF.update()
+        self.ss.DCPF.run()
+        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()
+        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)
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        # --- run DCPF ---
+        self.ss.DCPF.run()
+        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()
+        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='p0', attr='v', idx='PQ_1', value=0)
+        self.ss.DCPF.update()
+
+        self.ss.DCPF.run()
+        pgs_pqt2 = self.ss.DCPF.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
+
+
+class TestPFlow(unittest.TestCase):
+    """
+    Test routine `DCPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case('matpower/case14.m'),
+                           setup=True, no_output=True, default_config=True)
+
+    def test_init(self):
+        """
+        Test initialization.
+        """
+        self.ss.PFlow.init()
+        self.assertTrue(self.ss.PFlow.initialized, "PFlow initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        stg = 2
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+
+        self.ss.PFlow.update()
+        self.ss.PFlow.run()
+        self.assertTrue(self.ss.PFlow.converged, "PFlow did not converge under generator trip!")
+        self.assertAlmostEqual(self.ss.PFlow.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)
+
+    def test_trip_line(self):
+        """
+        Test line tripping.
+        """
+        self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
+
+        self.ss.PFlow.update()
+        self.ss.PFlow.run()
+        self.assertTrue(self.ss.PFlow.converged, "PFlow did not converge under line trip!")
+        self.assertAlmostEqual(self.ss.PFlow.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)
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        # --- run PFlow ---
+        self.ss.PFlow.run()
+        pgs = self.ss.PFlow.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.PFlow.update()
+
+        self.ss.PFlow.run()
+        pgs_pqt = self.ss.PFlow.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0)
+        self.ss.PFlow.update()
+
+        self.ss.PFlow.run()
+        pgs_pqt2 = self.ss.PFlow.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
+
+
+class TestACOPF(unittest.TestCase):
+    """
+    Test routine `ACOPF`.
+    """
+
+    def setUp(self) -> None:
+        self.ss = ams.load(ams.get_case('matpower/case14.m'),
+                           setup=True, no_output=True, default_config=True)
+
+    def test_init(self):
+        """
+        Test initialization.
+        """
+        self.ss.ACOPF.init()
+        self.assertTrue(self.ss.ACOPF.initialized, "ACOPF initialization failed!")
+
+    def test_trip_gen(self):
+        """
+        Test generator tripping.
+        """
+        stg = 2
+        self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
+
+        self.ss.ACOPF.update()
+        self.ss.ACOPF.run()
+        self.assertTrue(self.ss.ACOPF.converged, "ACOPF did not converge under generator trip!")
+        self.assertAlmostEqual(self.ss.ACOPF.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)
+
+    def test_trip_line(self):
+        """
+        Test line tripping.
+        """
+        self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
+
+        self.ss.ACOPF.update()
+        self.ss.ACOPF.run()
+        self.assertTrue(self.ss.ACOPF.converged, "ACOPF did not converge under line trip!")
+        self.assertAlmostEqual(self.ss.ACOPF.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)
+
+    def test_set_load(self):
+        """
+        Test setting and tripping load.
+        """
+        # --- run ACOPF ---
+        self.ss.ACOPF.run()
+        pgs = self.ss.ACOPF.pg.v.sum()
+
+        # --- set load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
+        self.ss.ACOPF.update()
+
+        self.ss.ACOPF.run()
+        pgs_pqt = self.ss.ACOPF.pg.v.sum()
+        self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
+
+        # --- trip load ---
+        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0)
+        self.ss.ACOPF.update()
+
+        self.ss.ACOPF.run()
+        pgs_pqt2 = self.ss.ACOPF.pg.v.sum()
+        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")