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

tests/test_1st_system.py

@@ -1,64 +0,0 @@
-import unittest
-
-import ams
-
-
-class TestCodegen(unittest.TestCase):
-    """
-    Test code generation.
-    """
-
-    def test_1_docs(self) -> None:
-        sp = ams.system.System()
-        out = ''
-        for tp in sp.types.values():
-            out += tp.doc_all()
-
-        out = ''
-        for group in sp.groups.values():
-            out += group.doc_all()
-
-    def test_docum(self) -> None:
-        sp = ams.load(ams.get_case('5bus/pjm5bus_demo.json'),
-                      setup=True, no_output=True)
-        sp.DCOPF.init()
-        docum = sp.DCOPF.docum
-        for export in ['plain', 'rest']:
-            docum._obj_doc(max_width=78, export=export)
-            docum._constr_doc(max_width=78, export=export)
-            docum._exprc_doc(max_width=78, export=export)
-            docum._var_doc(max_width=78, export=export)
-            docum._service_doc(max_width=78, export=export)
-            docum._param_doc(max_width=78, export=export)
-            docum.parent.config.doc(max_width=78, export=export)
-
-
-class TestParamCorrection(unittest.TestCase):
-    """
-    Test parameter correction.
-    """
-
-    def setUp(self) -> None:
-        """
-        Test setup.
-        """
-        self.ss = ams.load(ams.get_case('matpower/case14.m'),
-                           setup=False, no_output=True, default_config=True,)
-
-    def test_line_correction(self):
-        """
-        Test line correction.
-        """
-        self.ss.Line.rate_a.v[5] = 0.0
-        self.ss.Line.rate_b.v[6] = 0.0
-        self.ss.Line.rate_c.v[7] = 0.0
-        self.ss.Line.amax.v[8] = 0.0
-        self.ss.Line.amin.v[9] = 0.0
-
-        self.ss.setup()
-
-        self.assertIsNot(self.ss.Line.rate_a.v[5], 0.0)
-        self.assertIsNot(self.ss.Line.rate_b.v[6], 0.0)
-        self.assertIsNot(self.ss.Line.rate_c.v[7], 0.0)
-        self.assertIsNot(self.ss.Line.amax.v[8], 0.0)
-        self.assertIsNot(self.ss.Line.amin.v[9], 0.0)

tests/test_addressing.py

@@ -1,40 +0,0 @@
-import unittest
-import numpy as np
-
-import ams
-
-ams.config_logger(stream_level=40)
-
-
-class TestAddressing(unittest.TestCase):
-    """
-    Tests for addressing.
-    """
-
-    def test_ieee14_address(self):
-        """
-        Test IEEE14 address.
-        """
-
-        # FIXME: why there will be case parsing information using ams.system.example()?
-        ss = ams.system.example()
-
-        # bus variable indices (internal)
-        np.testing.assert_array_equal(ss.Bus.a.a,
-                                      np.arange(0, ss.Bus.n, 1))
-        np.testing.assert_array_equal(ss.Bus.v.a,
-                                      np.arange(ss.Bus.n, 2*ss.Bus.n, 1))
-
-        # external variable indices
-        np.testing.assert_array_equal(ss.PV.ud.a,
-                                      np.array([31, 32, 33, 34]))
-        np.testing.assert_array_equal(ss.PV.p.a,
-                                      np.array([35, 36, 37, 38]))
-        np.testing.assert_array_equal(ss.PV.q.a,
-                                      np.array([39, 40, 41, 42]))
-        np.testing.assert_array_equal(ss.Slack.ud.a,
-                                      np.array([28]))
-        np.testing.assert_array_equal(ss.Slack.p.a,
-                                      np.array([29]))
-        np.testing.assert_array_equal(ss.Slack.q.a,
-                                      np.array([30]))

tests/test_case.py

@@ -1,301 +0,0 @@
-import os
-import unittest
-
-import numpy as np
-
-import ams
-from ams.utils.paths import get_case
-
-
-class Test5Bus(unittest.TestCase):
-    """
-    Tests for the 5-bus system.
-    """
-
-    def setUp(self) -> None:
-        self.ss = ams.main.load(
-            get_case("5bus/pjm5bus_demo.json"),
-            default_config=True,
-            no_output=True,
-        )
-
-    def test_essential(self):
-        """
-        Test essential functionalities of Model and System.
-        """
-
-        # --- test model names
-        self.assertTrue("Bus" in self.ss.models)
-        self.assertTrue("PQ" in self.ss.models)
-
-        nBus = 5
-        nGen = 5
-        nPQ = 3
-        nArea = 3
-        nZone = 5
-        nDT = 24
-        # --- test device counts
-        self.assertEqual(self.ss.Bus.n, nBus)
-        self.assertEqual(self.ss.PQ.n, nPQ)
-        self.assertEqual(self.ss.PV.n, 4)
-        self.assertEqual(self.ss.Slack.n, 1)
-        self.assertEqual(self.ss.Line.n, 7)
-        self.assertEqual(self.ss.Zone.n, nZone)
-        self.assertEqual(self.ss.Area.n, nArea)
-        self.assertEqual(self.ss.SFR.n, nArea)
-        self.assertEqual(self.ss.SR.n, nArea)
-        self.assertEqual(self.ss.NSR.n, nArea)
-        self.assertEqual(self.ss.GCost.n, nGen)
-        self.assertEqual(self.ss.DCost.n, nPQ)
-        self.assertEqual(self.ss.SFRCost.n, nGen)
-        self.assertEqual(self.ss.SRCost.n, nGen)
-        self.assertEqual(self.ss.NSRCost.n, nGen)
-        self.assertEqual(self.ss.EDTSlot.n, nDT)
-        self.assertEqual(self.ss.UCTSlot.n, nDT)
-
-        # test idx values
-        self.assertSequenceEqual(self.ss.Bus.idx.v, [0, 1, 2, 3, 4])
-        self.assertSequenceEqual(self.ss.Area.idx.v, [1, 2, 3])
-
-        # test cache refreshing
-        self.ss.Bus.cache.refresh()  # used in ANDES but not in AMS
-
-        # test conversion to dataframe
-        self.ss.Bus.as_df()
-        self.ss.Bus.as_df(vin=True)
-
-        # test conversion to dataframe of ``Horizon`` model
-        self.ss.EDTSlot.as_df()
-        self.ss.EDTSlot.as_df(vin=True)
-
-        self.ss.UCTSlot.as_df()
-        self.ss.UCTSlot.as_df(vin=True)
-
-    def test_pflow_reset(self):
-        """
-        Test resetting power flow.
-        """
-
-        self.ss.PFlow.run()
-        self.ss.reset()
-        self.ss.PFlow.run()
-
-    def test_alter_param(self):
-        """
-        Test altering parameter for power flow.
-        """
-
-        self.ss.PV.alter("v0", "PV_3", 0.98)
-        self.assertEqual(self.ss.PV.v0.v[1], 0.98)
-        self.ss.PFlow.run()
-
-    def test_alter_param_before_routine(self):
-        """
-        Test altering parameter before running routine.
-        """
-
-        self.ss.GCost.alter("c1", ['GCost_1', 'GCost_2'], [1500., 3100.])
-        np.testing.assert_array_equal(self.ss.GCost.c1.v, [1500., 3100., 0.4, 0.1, 0.01])
-        self.ss.ACOPF.run()
-        np.testing.assert_array_equal(self.ss.GCost.c1.v, [1500., 3100., 0.4, 0.1, 0.01])
-
-    def test_alter_param_after_routine(self):
-        """
-        Test altering parameter after running routine.
-        """
-
-        self.ss.ACOPF.run()
-        self.ss.GCost.alter("c1", ['GCost_1', 'GCost_2'], [1500., 3100.])
-        np.testing.assert_array_equal(self.ss.GCost.c1.v, [1500., 3100., 0.4, 0.1, 0.01])
-        self.ss.ACOPF.run()
-        np.testing.assert_array_equal(self.ss.GCost.c1.v, [1500., 3100., 0.4, 0.1, 0.01])
-
-    # def test_multiple_disconnected_line(self):
-    #     """
-    #     Test connectivity check for systems with disconnected lines.
-
-    #     These disconnected lines (zeros) was not excluded when counting
-    #     connected buses, causing an out-of-bound error.
-    #     """
-    #     # TODO: need to add `connectivity` in `system`
-    #     pass
-    #     # self.ss.Line.u.v[[0, 6]] = 0
-    #     # self.ss.PFlow.run()
-    #     # self.assertEqual(len(self.ss.Bus.islands), 1)
-    #     # self.assertEqual(self.ss.Bus.n_islanded_buses, 0)
-
-
-class TestIEEE14RAW(unittest.TestCase):
-    """
-    Test IEEE14 system in the RAW format.
-    """
-
-    # TODO: after add `run` in `system`, improve this part
-    def test_ieee14_raw(self):
-        ss = ams.load(
-            get_case("ieee14/ieee14.raw"),
-            default_config=True,
-            no_output=True,
-        )
-        ss.PFlow.run()
-        self.assertEqual(ss.PFlow.exit_code, 0, "Exit code is not 0.")
-
-    def test_ieee14_raw_convert(self):
-        ss = ams.run(
-            get_case("ieee14/ieee14.raw"),
-            convert=True,
-            default_config=True,
-        )
-        os.remove(ss.files.dump)
-        self.assertEqual(ss.exit_code, 0, "Exit code is not 0.")
-
-    def test_ieee14_raw2xlsx(self):
-        ss = ams.load(
-            get_case("ieee14/ieee14.raw"),
-            setup=True,
-            no_output=True,
-            default_config=True,
-        )
-        ams.io.xlsx.write(ss, "ieee14.xlsx", overwrite=True)
-        self.assertTrue(os.path.exists("ieee14.xlsx"))
-        os.remove("ieee14.xlsx")
-
-    def test_ieee14_raw2json(self):
-        ss = ams.load(
-            get_case("ieee14/ieee14.raw"),
-            setup=True,
-            no_output=True,
-            default_config=True,
-        )
-        ams.io.json.write(ss, "ieee14.json", overwrite=True)
-        self.assertTrue(os.path.exists("ieee14.json"))
-        os.remove("ieee14.json")
-
-    def test_ieee14_raw2json_convert(self):
-        ss = ams.run(
-            get_case("ieee14/ieee14.raw"),
-            convert="json",
-            default_config=True,
-        )
-
-        ss2 = ams.run(
-            "ieee14.json",
-            default_config=True,
-            no_output=True,
-        )
-
-        os.remove(ss.files.dump)
-        self.assertEqual(ss2.exit_code, 0, "Exit code is not 0.")
-
-    def test_read_json_from_memory(self):
-        fd = open(get_case("ieee14/ieee14.json"), "r")
-
-        ss = ams.main.System(
-            default_config=True,
-            no_output=True,
-        )
-        ams.io.json.read(ss, fd)
-        ss.setup()
-        ss.PFlow.run()
-
-        fd.close()
-        self.assertEqual(ss.exit_code, 0, "Exit code is not 0.")
-
-    def test_read_mpc_from_memory(self):
-        fd = open(get_case("matpower/case14.m"), "r")
-
-        ss = ams.main.System(
-            default_config=True,
-            no_output=True,
-        )
-        ams.io.matpower.read(ss, fd)
-        ss.setup()
-        ss.PFlow.run()
-
-        fd.close()
-        self.assertEqual(ss.exit_code, 0, "Exit code is not 0.")
-
-    def test_read_psse_from_memory(self):
-        fd_raw = open(get_case("ieee14/ieee14.raw"), "r")
-
-        ss = ams.main.System(
-            default_config=True,
-            no_output=True,
-        )
-        # suppress out-of-normal info
-        ss.config.warn_limits = 0
-        ss.config.warn_abnormal = 0
-
-        ams.io.psse.read(ss, fd_raw)
-        ss.setup()
-        ss.PFlow.run()
-
-        fd_raw.close()
-        self.assertEqual(ss.exit_code, 0, "Exit code is not 0.")
-
-
-class TestCaseInit(unittest.TestCase):
-    """
-    Test if initializations pass.
-    """
-
-    def test_ieee39_init(self):
-        """
-        Test if ieee39 initialization works.
-        """
-        ss = ams.load(
-            get_case("ieee39/ieee39_uced.xlsx"),
-            default_config=True,
-            no_output=True,
-        )
-        ss.DCOPF.init()
-        ss.RTED.init()
-        ss.ED.init()
-        ss.UC.init()
-
-        self.assertEqual(ss.DCOPF.exit_code, 0, "Exit code is not 0.")
-        self.assertEqual(ss.RTED.exit_code, 0, "Exit code is not 0.")
-        self.assertEqual(ss.ED.exit_code, 0, "Exit code is not 0.")
-        self.assertEqual(ss.UC.exit_code, 0, "Exit code is not 0.")
-
-    def test_ieee39_esd1_init(self):
-        """
-        Test if ieee39 with ESD1 initialization works.
-        """
-        ss = ams.load(
-            get_case("ieee39/ieee39_uced_esd1.xlsx"),
-            default_config=True,
-            no_output=True,
-        )
-        ss.EDES.init()
-        ss.UCES.init()
-
-        self.assertEqual(ss.EDES.exit_code, 0, "Exit code is not 0.")
-        self.assertEqual(ss.UCES.exit_code, 0, "Exit code is not 0.")
-
-
-class TestCase14(unittest.TestCase):
-    """
-    Test parameter correction using case14.m
-    """
-
-    def test_parameter_correction(self):
-        """
-        Test if the parameter correction works.
-        """
-        mpc = ams.io.matpower.m2mpc(get_case("matpower/case14.m"))
-        mpc['branch'][:, 11] = 0.0
-        mpc['branch'][:, 12] = 0.0
-
-        ss = ams.system.System()
-        ams.io.matpower.mpc2system(mpc, ss)
-        ss.setup()
-
-        # line rate
-        np.testing.assert_array_less(0.0, ss.Line.rate_a.v)
-        np.testing.assert_array_less(0.0, ss.Line.rate_b.v)
-        np.testing.assert_array_less(0.0, ss.Line.rate_c.v)
-
-        # line angle difference
-        np.testing.assert_array_less(0.0, ss.Line.amax.v)
-        np.testing.assert_array_less(ss.Line.amin.v, 0.0)

tests/test_cli.py

@@ -1,34 +0,0 @@
-import unittest
-import os
-
-import ams.main
-import ams.cli
-
-
-class TestCLI(unittest.TestCase):
-
-    def test_cli_parser(self):
-        ams.cli.create_parser()
-
-    def test_cli_preamble(self):
-        ams.cli.preamble()
-
-    def test_main_doc(self):
-        ams.main.doc('Bus')
-        ams.main.doc(list_supported=True)
-
-    def test_versioninfo(self):
-        ams.main.versioninfo()
-
-    def test_misc(self):
-        ams.main.misc(show_license=True)
-        ams.main.misc(save_config=None, overwrite=True)
-
-    def test_profile_run(self):
-        _ = ams.main.run(ams.get_case('matpower/case5.m'),
-                         no_output=False,
-                         profile=True,)
-        self.assertTrue(os.path.exists('case5_prof.prof'))
-        self.assertTrue(os.path.exists('case5_prof.txt'))
-        os.remove('case5_prof.prof')
-        os.remove('case5_prof.txt')

tests/test_export_csv.py

@@ -1,89 +0,0 @@
-"""
-Test routine export to CSV.
-"""
-import unittest
-import os
-import csv
-
-import numpy as np
-
-import ams
-
-
-class TestExportCSV(unittest.TestCase):
-    """
-    Tests for Routine export to CSV.
-    """
-
-    def setUp(self) -> None:
-        self.ss = ams.main.load(
-            ams.get_case("5bus/pjm5bus_demo.json"),
-            default_config=True,
-            no_output=True,
-        )
-        self.expected_csv_DCOPF = 'pjm5bus_demo_DCOPF.csv'
-        self.expected_csv_ED = 'pjm5bus_demo_ED.csv'
-
-    def test_no_export(self):
-        """
-        Test no export when routine is not converged.
-        """
-        self.assertIsNone(self.ss.DCOPF.export_csv())
-
-    def test_export_DCOPF(self):
-        """
-        Test export DCOPF to CSV.
-        """
-        self.ss.DCOPF.run(solver='CLARABEL')
-        self.ss.DCOPF.export_csv()
-        self.assertTrue(os.path.exists(self.expected_csv_DCOPF))
-
-        n_rows = 0
-        n_cols = 0
-        with open(self.expected_csv_DCOPF, 'r') as csv_file:
-            csv_reader = csv.reader(csv_file)
-            for row in csv_reader:
-                n_rows += 1
-                # Check if this row has more columns than the previous rows
-                if n_cols == 0 or len(row) > n_cols:
-                    n_cols = len(row)
-
-        n_cols_expected = np.sum([v.owner.n for v in self.ss.DCOPF.vars.values()])
-        n_cols_expected += np.sum([v.owner.n for v in self.ss.DCOPF.exprs.values()])
-        n_cols_expected += np.sum([v.owner.n for v in self.ss.DCOPF.exprcs.values()])
-        # cols number plus one for the index column
-        self.assertEqual(n_cols, n_cols_expected + 1)
-        # header row plus data row
-        n_rows_expected = 2
-        self.assertEqual(n_rows, n_rows_expected)
-
-        os.remove(self.expected_csv_DCOPF)
-
-    def test_export_ED(self):
-        """
-        Test export ED to CSV.
-        """
-        self.ss.ED.run(solver='CLARABEL')
-        self.ss.ED.export_csv()
-        self.assertTrue(os.path.exists(self.expected_csv_ED))
-
-        n_rows = 0
-        n_cols = 0
-        with open(self.expected_csv_ED, 'r') as csv_file:
-            csv_reader = csv.reader(csv_file)
-            for row in csv_reader:
-                n_rows += 1
-                # Check if this row has more columns than the previous rows
-                if n_cols == 0 or len(row) > n_cols:
-                    n_cols = len(row)
-
-        n_cols_expected = np.sum([v.owner.n for v in self.ss.ED.vars.values()])
-        n_cols_expected += np.sum([v.owner.n for v in self.ss.ED.exprs.values()])
-        n_cols_expected += np.sum([v.owner.n for v in self.ss.ED.exprcs.values()])
-        # cols number plus one for the index column
-        self.assertEqual(n_cols, n_cols_expected + 1)
-        # header row plus data row
-        n_rows_expected = len(self.ss.ED.timeslot.v) + 1
-        self.assertTrue(n_rows, n_rows_expected)
-
-        os.remove(self.expected_csv_ED)

tests/test_group.py

@@ -1,83 +0,0 @@
-"""
-Tests for group functions.
-"""
-import unittest
-
-import numpy as np
-
-import ams
-
-
-class TestGroup(unittest.TestCase):
-    """
-    Test the group class functions.
-    """
-
-    def setUp(self):
-        self.ss = ams.run(ams.get_case("ieee39/ieee39_uced_esd1.xlsx"),
-                          default_config=True,
-                          no_output=True,
-                          )
-
-    def test_group_access(self):
-        """
-        Test methods such as `idx2model`
-        """
-        ss = self.ss
-
-        # --- idx2uid ---
-        self.assertIsNone(ss.DG.idx2uid(None))
-        self.assertListEqual(ss.DG.idx2uid([None]), [None])
-
-        # --- idx2model ---
-        # what works
-        self.assertIs(ss.DG.idx2model('ESD1_1'), ss.ESD1)
-        self.assertListEqual(ss.DG.idx2model(['ESD1_1']), [ss.ESD1])
-
-        # what does not work
-        self.assertRaises(KeyError, ss.DG.idx2model, idx='1')
-        self.assertRaises(KeyError, ss.DG.idx2model, idx=88)
-        self.assertRaises(KeyError, ss.DG.idx2model, idx=[1, 88])
-
-        # --- get ---
-        self.assertRaises(KeyError, ss.DG.get, 'EtaC', 999)
-
-        np.testing.assert_equal(ss.DG.get('EtaC', 'ESD1_1',), 1.0)
-
-        np.testing.assert_equal(ss.DG.get('EtaC', ['ESD1_1'], allow_none=True,),
-                                [1.0])
-        np.testing.assert_equal(ss.DG.get('EtaC', ['ESD1_1', None],
-                                          allow_none=True, default=0.95),
-                                [1.0, 0.95])
-
-        # --- set ---
-        ss.DG.set('EtaC', 'ESD1_1', 'v', 0.95)
-        np.testing.assert_equal(ss.DG.get('EtaC', 'ESD1_1',), 0.95)
-
-        ss.DG.set('EtaC', ['ESD1_1'], 'v', 0.97)
-        np.testing.assert_equal(ss.DG.get('EtaC', ['ESD1_1'],), [0.97])
-
-        ss.DG.set('EtaC', ['ESD1_1'], 'v', [0.99])
-        np.testing.assert_equal(ss.DG.get('EtaC', ['ESD1_1'],), [0.99])
-
-        # --- find_idx ---
-        self.assertListEqual(ss.DG.find_idx('name', ['ESD1_1']),
-                             ss.ESD1.find_idx('name', ['ESD1_1']),
-                             )
-
-        self.assertListEqual(ss.DG.find_idx(['name', 'Sn'],
-                                            [('ESD1_1',),
-                                             (100.0,)]),
-                             ss.ESD1.find_idx(['name', 'Sn'],
-                                              [('ESD1_1',),
-                                               (100.0,)]),)
-
-        # --- get group idx ---
-        self.assertListEqual(ss.DG.get_all_idxes(), ss.ESD1.idx.v)
-
-    def test_group_repr(self):
-        """
-        Test `Group.__repr__()` method.
-        """
-        for grp in self.ss.groups.items():
-            print(grp.__repr__())