ltbams 1.0.12__py3-none-any.whl → 1.0.13__py3-none-any.whl

tests/test_routine.py

@@ -1,178 +0,0 @@
-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.json"),
-                           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.json"),
-                           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_acopf.py

@@ -1,75 +0,0 @@
-import unittest
-
-import ams
-
-
-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!")

tests/test_rtn_dcopf.py

@@ -1,121 +0,0 @@
-import os
-
-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.json"),
-                           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)
-
-    def test_export_csv(self):
-        """
-        Test `Routine.export_csv()` method.
-        """
-        self.ss.DCOPF.run(solver='CLARABEL')
-
-        # test when path is none
-        out = self.ss.DCOPF.export_csv()
-        self.assertTrue(os.path.exists(out), "CSV export failed!")
-
-        # test when path is not none
-        out2 = self.ss.DCOPF.export_csv(path='test_dcopf.csv')
-        self.assertTrue(os.path.exists(out2), "CSV export with path failed!")
-
-        # Clean up
-        os.remove(out)
-        os.remove(out2)

tests/test_rtn_dcopf2.py

@@ -1,103 +0,0 @@
-import unittest
-import numpy as np
-
-import ams
-
-
-class TestDCOPF2(unittest.TestCase):
-    """
-    Test routine `DCOPF2`.
-    """
-
-    def setUp(self) -> None:
-        self.ss = ams.load(ams.get_case("5bus/pjm5bus_demo.json"),
-                           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])
-        # build PTDF
-        self.ss.mats.build_ptdf()
-
-    def test_init(self):
-        """
-        Test initialization.
-        """
-        self.ss.DCOPF2.init()
-        self.assertTrue(self.ss.DCOPF2.initialized, "DCOPF2 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.DCOPF2.update()
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        self.assertTrue(self.ss.DCOPF2.converged, "DCOPF2 did not converge under generator trip!")
-        self.assertAlmostEqual(self.ss.DCOPF2.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.DCOPF2.update()
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        self.assertTrue(self.ss.DCOPF2.converged, "DCOPF2 did not converge under line trip!")
-        self.assertAlmostEqual(self.ss.DCOPF2.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 DCOPF2 ---
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        pgs = self.ss.DCOPF2.pg.v.sum()
-
-        # --- set load ---
-        self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
-        self.ss.DCOPF2.update()
-
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        pgs_pqt = self.ss.DCOPF2.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.DCOPF2.update()
-
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        pgs_pqt2 = self.ss.DCOPF2.pg.v.sum()
-        self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
-
-    def test_dc2ac(self):
-        """
-        Test `DCOPF2.dc2ac()` method.
-        """
-        self.ss.DCOPF2.run(solver='CLARABEL')
-        self.ss.DCOPF2.dc2ac()
-        self.assertTrue(self.ss.DCOPF2.converted, "AC conversion failed!")
-        self.assertTrue(self.ss.DCOPF2.exec_time > 0, "Execution time is not greater than 0.")
-
-        stg_idx = self.ss.StaticGen.get_all_idxes()
-        pg_dcopf = self.ss.DCOPF2.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.DCOPF2.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.DCOPF2.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)