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

tests/test_rtn_rted.py

@@ -2,7 +2,7 @@ import unittest
 import numpy as np
 
 import ams
-from ams.shared import skip_unittest_without_MIP
+from ams.shared import skip_unittest_without_MISOCP
 
 
 class TestRTED(unittest.TestCase):
@@ -215,7 +215,7 @@ class TestRTEDES(unittest.TestCase):
         self.ss.RTEDES.init()
         self.assertTrue(self.ss.RTEDES.initialized, "RTEDES initialization failed!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_gen(self):
         """
         Test generator tripping.
@@ -224,7 +224,7 @@ class TestRTEDES(unittest.TestCase):
         self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=0)
 
         self.ss.RTEDES.update()
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         self.assertTrue(self.ss.RTEDES.converged, "RTEDES did not converge under generator trip!")
         self.assertAlmostEqual(self.ss.RTEDES.get(src='pg', attr='v', idx=stg),
                                0, places=6,
@@ -232,7 +232,7 @@ class TestRTEDES(unittest.TestCase):
 
         self.ss.StaticGen.set(src='u', idx=stg, attr='v', value=1)
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_line(self):
         """
         Test line tripping.
@@ -240,7 +240,7 @@ class TestRTEDES(unittest.TestCase):
         self.ss.Line.set(src='u', attr='v', idx=3, value=0)
 
         self.ss.RTEDES.update()
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         self.assertTrue(self.ss.RTEDES.converged, "RTEDES did not converge under line trip!")
         self.assertAlmostEqual(self.ss.RTEDES.get(src='plf', attr='v', idx=3),
                                0, places=6,
@@ -248,19 +248,19 @@ class TestRTEDES(unittest.TestCase):
 
         self.ss.Line.alter(src='u', idx=3, value=1)
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_set_load(self):
         """
         Test setting and tripping load.
         """
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         pgs = self.ss.RTEDES.pg.v.sum()
 
         # --- set load ---
         self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.05)
         self.ss.RTEDES.update()
 
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         pgs_pqt = self.ss.RTEDES.pg.v.sum()
         self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
 
@@ -268,6 +268,6 @@ class TestRTEDES(unittest.TestCase):
         self.ss.PQ.set(src='u', attr='v', idx='PQ_2', value=0)
         self.ss.RTEDES.update()
 
-        self.ss.RTEDES.run(solver='SCIP')
+        self.ss.RTEDES.run()
         pgs_pqt2 = self.ss.RTEDES.pg.v.sum()
         self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")

tests/test_rtn_uc.py

@@ -2,7 +2,7 @@ import unittest
 import numpy as np
 
 import ams
-from ams.shared import skip_unittest_without_MIP
+from ams.shared import skip_unittest_without_MISOCP
 
 
 class TestUC(unittest.TestCase):
@@ -33,31 +33,31 @@ class TestUC(unittest.TestCase):
         self.ss.UC.init()
         self.assertTrue(self.ss.UC.initialized, "UC initialization failed!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_gen(self):
         """
         Test generator tripping.
         """
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         self.assertTrue(self.ss.UC.converged, "UC did not converge!")
         pg_off_gen = self.ss.UC.get(src='pg', attr='v', idx=self.off_gen)
         np.testing.assert_almost_equal(np.zeros_like(pg_off_gen),
                                        pg_off_gen, decimal=6,
                                        err_msg="Off generators are not turned off!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_set_load(self):
         """
         Test setting and tripping load.
         """
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         pgs = self.ss.UC.pg.v.sum()
 
         # --- set load ---
         self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
         self.ss.UC.update()
 
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         pgs_pqt = self.ss.UC.pg.v.sum()
         self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
 
@@ -65,11 +65,11 @@ class TestUC(unittest.TestCase):
         self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
         self.ss.UC.update()
 
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         pgs_pqt2 = self.ss.UC.pg.v.sum()
         self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_line(self):
         """
         Test line tripping.
@@ -77,7 +77,7 @@ class TestUC(unittest.TestCase):
         self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
         self.ss.UC.update()
 
-        self.ss.UC.run(solver='SCIP')
+        self.ss.UC.run()
         self.assertTrue(self.ss.UC.converged, "UC did not converge under line trip!")
         plf_l3 = self.ss.UC.get(src='plf', attr='v', idx='Line_3')
         np.testing.assert_almost_equal(np.zeros_like(plf_l3),
@@ -114,31 +114,31 @@ class TestUCDG(unittest.TestCase):
         self.ss.UCDG.init()
         self.assertTrue(self.ss.UCDG.initialized, "UCDG initialization failed!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_gen(self):
         """
         Test generator tripping.
         """
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         self.assertTrue(self.ss.UCDG.converged, "UCDG did not converge!")
         pg_off_gen = self.ss.UCDG.get(src='pg', attr='v', idx=self.off_gen)
         np.testing.assert_almost_equal(np.zeros_like(pg_off_gen),
                                        pg_off_gen, decimal=6,
                                        err_msg="Off generators are not turned off!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_set_load(self):
         """
         Test setting and tripping load.
         """
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         pgs = self.ss.UCDG.pg.v.sum()
 
         # --- set load ---
         self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
         self.ss.UCDG.update()
 
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         pgs_pqt = self.ss.UCDG.pg.v.sum()
         self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
 
@@ -146,11 +146,11 @@ class TestUCDG(unittest.TestCase):
         self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
         self.ss.UCDG.update()
 
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         pgs_pqt2 = self.ss.UCDG.pg.v.sum()
         self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_line(self):
         """
         Test line tripping.
@@ -158,7 +158,7 @@ class TestUCDG(unittest.TestCase):
         self.ss.Line.set(src='u', attr='v', idx='Line_3', value=0)
         self.ss.UCDG.update()
 
-        self.ss.UCDG.run(solver='SCIP')
+        self.ss.UCDG.run()
         self.assertTrue(self.ss.UCDG.converged, "UCDG did not converge under line trip!")
         plf_l3 = self.ss.UCDG.get(src='plf', attr='v', idx='Line_3')
         np.testing.assert_almost_equal(np.zeros_like(plf_l3),
@@ -195,31 +195,31 @@ class TestUCES(unittest.TestCase):
         self.ss.UCES.init()
         self.assertTrue(self.ss.UCES.initialized, "UCES initialization failed!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_gen(self):
         """
         Test generator tripping.
         """
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         self.assertTrue(self.ss.UCES.converged, "UCES did not converge!")
         pg_off_gen = self.ss.UCES.get(src='pg', attr='v', idx=self.off_gen)
         np.testing.assert_almost_equal(np.zeros_like(pg_off_gen),
                                        pg_off_gen, decimal=6,
                                        err_msg="Off generators are not turned off!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_set_load(self):
         """
         Test setting and tripping load.
         """
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         pgs = self.ss.UCES.pg.v.sum()
 
         # --- set load ---
         self.ss.PQ.set(src='p0', attr='v', idx='PQ_1', value=0.1)
         self.ss.UCES.update()
 
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         pgs_pqt = self.ss.UCES.pg.v.sum()
         self.assertLess(pgs_pqt, pgs, "Load set does not take effect!")
 
@@ -227,11 +227,11 @@ class TestUCES(unittest.TestCase):
         self.ss.PQ.alter(src='u', idx='PQ_2', value=0)
         self.ss.UCES.update()
 
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         pgs_pqt2 = self.ss.UCES.pg.v.sum()
         self.assertLess(pgs_pqt2, pgs_pqt, "Load trip does not take effect!")
 
-    @skip_unittest_without_MIP
+    @skip_unittest_without_MISOCP
     def test_trip_line(self):
         """
         Test line tripping.
@@ -239,7 +239,7 @@ class TestUCES(unittest.TestCase):
         self.ss.Line.set(src='u', attr='v', idx=3, value=0)
         self.ss.UCES.update()
 
-        self.ss.UCES.run(solver='SCIP')
+        self.ss.UCES.run()
         self.assertTrue(self.ss.UCES.converged, "UCES did not converge under line trip!")
         plf_l3 = self.ss.UCES.get(src='plf', attr='v', idx=3)
         np.testing.assert_almost_equal(np.zeros_like(plf_l3),

ams/routines/pflow1.py

@@ -1,156 +0,0 @@
-"""
-Power flow routines using PyOptInterface.
-"""
-from pyoptinterface import nlfunc, ipopt
-import pyoptinterface as poi
-import math
-
-import logging
-from typing import Optional, Union, Type
-from collections import OrderedDict
-
-import numpy as np
-
-from andes.utils.misc import elapsed
-
-from ams.core.param import RParam
-from ams.routines.routine import RoutineBase
-from ams.opt import Var, Expression, Objective
-
-logger = logging.getLogger(__name__)
-
-
-class PFlow1(RoutineBase):
-    """
-    UNDER DEVELOPMENT!
-    
-    Power flow analysis using PyOptInterface.
-
-    References
-    ----------
-    [1] Y. Yang, C. Lin, L. Xu, X. Yang, W. Wu and B. Wang, "Accelerating Optimal Power Flow with
-    Structure-aware Automatic Differentiation and Code Generation," in IEEE Transactions on Power Systems
-
-    [2] Y. Yang, C. Lin, L. Xu, and W. Wu, "PyOptInterface: Design and implementation of an efficient
-    modeling language for mathematical optimization," arXiv, 2024.
-    """
-
-    def __init__(self, system, config):
-        RoutineBase.__init__(self, system, config)
-        self.info = 'AC Power Flow'
-        self.type = 'PF'
-        self._adsys = None
-
-        self.config.add(OrderedDict((('tol', 1e-6),
-                                     )))
-        self.config.add_extra("_help",
-                              tol="convergence tolerance",
-                              )
-        self.config.add_extra("_alt",
-                              tol="float",
-                              )
-
-        self.Bf = RParam(info='Bf matrix',
-                         name='Bf', tex_name=r'B_{f}',
-                         model='mats', src='Bf',
-                         no_parse=True, sparse=True,)
-        self.Pfinj = RParam(info='Line power injection vector',
-                            name='Pfinj', tex_name=r'P_{f}^{inj}',
-                            model='mats', src='Pfinj',
-                            no_parse=True,)
-
-        self.pg = Var(info='Gen active power',
-                      unit='p.u.',
-                      name='pg', tex_name=r'p_g',
-                      model='StaticGen', src='p')
-        self.qg = Var(info='Gen reactive power',
-                      unit='p.u.',
-                      name='qg', tex_name=r'q_g',
-                      model='StaticGen', src='q')
-        self.aBus = Var(info='Bus voltage angle',
-                        unit='rad',
-                        name='aBus', tex_name=r'\theta_{bus}',
-                        model='Bus', src='a',)
-        self.vBus = Var(info='Bus voltage magnitude',
-                        unit='p.u.',
-                        name='vBus', tex_name=r'V_{bus}',
-                        model='Bus', src='v',)
-        self.plf = Expression(info='Line flow',
-                              name='plf', tex_name=r'p_{lf}',
-                              unit='p.u.',
-                              e_str='Bf@aBus + Pfinj',
-                              model='Line', src=None,)
-
-        self.obj = Objective(name='obj',
-                             info='place holder', unit='$',
-                             sense='min', e_str='0',)
-
-    def enable(self, name):
-        raise NotImplementedError
-
-    def disable(self, name):
-        raise NotImplementedError
-
-    def addRParam(self,
-                  name: str,
-                  tex_name: Optional[str] = None,
-                  info: Optional[str] = None,
-                  src: Optional[str] = None,
-                  unit: Optional[str] = None,
-                  model: Optional[str] = None,
-                  v: Optional[np.ndarray] = None,
-                  indexer: Optional[str] = None,
-                  imodel: Optional[str] = None,):
-        """
-        Not supported!
-        """
-        raise NotImplementedError
-
-    def addService(self,
-                   name: str,
-                   value: np.ndarray,
-                   tex_name: str = None,
-                   unit: str = None,
-                   info: str = None,
-                   vtype: Type = None,):
-        """
-        Not supported!
-        """
-        raise NotImplementedError
-
-    def addConstrs(self,
-                   name: str,
-                   e_str: str,
-                   info: Optional[str] = None,
-                   is_eq: Optional[str] = False,):
-        """
-        Not supported!
-        """
-        raise NotImplementedError
-
-    def addVars(self,
-                name: str,
-                model: Optional[str] = None,
-                shape: Optional[Union[int, tuple]] = None,
-                tex_name: Optional[str] = None,
-                info: Optional[str] = None,
-                src: Optional[str] = None,
-                unit: Optional[str] = None,
-                horizon: Optional[RParam] = None,
-                nonneg: Optional[bool] = False,
-                nonpos: Optional[bool] = False,
-                cplx: Optional[bool] = False,
-                imag: Optional[bool] = False,
-                symmetric: Optional[bool] = False,
-                diag: Optional[bool] = False,
-                psd: Optional[bool] = False,
-                nsd: Optional[bool] = False,
-                hermitian: Optional[bool] = False,
-                boolean: Optional[bool] = False,
-                integer: Optional[bool] = False,
-                pos: Optional[bool] = False,
-                neg: Optional[bool] = False,):
-        """
-        Not supported!
-        """
-        raise NotImplementedError

docs/source/_generated/_generated/ams.core.model.Model.alter.rst

@@ -1,6 +0,0 @@
-Model.alter
-===========
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.alter

docs/source/_generated/_generated/ams.core.model.Model.class_name.rst

@@ -1,6 +0,0 @@
-Model.class\_name
-=================
-
-.. currentmodule:: ams.core.model
-
-.. autoproperty:: Model.class_name

docs/source/_generated/_generated/ams.core.model.Model.doc.rst

@@ -1,6 +0,0 @@
-Model.doc
-=========
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.doc

docs/source/_generated/_generated/ams.core.model.Model.get.rst

@@ -1,6 +0,0 @@
-Model.get
-=========
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.get

docs/source/_generated/_generated/ams.core.model.Model.get_idx.rst

@@ -1,6 +0,0 @@
-Model.get\_idx
-==============
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.get_idx

docs/source/_generated/_generated/ams.core.model.Model.idx2uid.rst

@@ -1,6 +0,0 @@
-Model.idx2uid
-=============
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.idx2uid

docs/source/_generated/_generated/ams.core.model.Model.list2array.rst

@@ -1,6 +0,0 @@
-Model.list2array
-================
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.list2array

docs/source/_generated/_generated/ams.core.model.Model.set.rst

@@ -1,6 +0,0 @@
-Model.set
-=========
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.set

docs/source/_generated/_generated/ams.core.model.Model.set_backref.rst

@@ -1,6 +0,0 @@
-Model.set\_backref
-==================
-
-.. currentmodule:: ams.core.model
-
-.. automethod:: Model.set_backref

docs/source/_generated/_generated/ams.core.param.RParam.class_name.rst

@@ -1,6 +0,0 @@
-RParam.class\_name
-==================
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.class_name

docs/source/_generated/_generated/ams.core.param.RParam.dtype.rst

@@ -1,6 +0,0 @@
-RParam.dtype
-============
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.dtype

docs/source/_generated/_generated/ams.core.param.RParam.evaluate.rst

@@ -1,6 +0,0 @@
-RParam.evaluate
-===============
-
-.. currentmodule:: ams.core.param
-
-.. automethod:: RParam.evaluate

docs/source/_generated/_generated/ams.core.param.RParam.get_idx.rst

@@ -1,6 +0,0 @@
-RParam.get\_idx
-===============
-
-.. currentmodule:: ams.core.param
-
-.. automethod:: RParam.get_idx

docs/source/_generated/_generated/ams.core.param.RParam.n.rst

@@ -1,6 +0,0 @@
-RParam.n
-========
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.n

docs/source/_generated/_generated/ams.core.param.RParam.parse.rst

@@ -1,6 +0,0 @@
-RParam.parse
-============
-
-.. currentmodule:: ams.core.param
-
-.. automethod:: RParam.parse

docs/source/_generated/_generated/ams.core.param.RParam.shape.rst

@@ -1,6 +0,0 @@
-RParam.shape
-============
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.shape

docs/source/_generated/_generated/ams.core.param.RParam.size.rst

@@ -1,6 +0,0 @@
-RParam.size
-===========
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.size

docs/source/_generated/_generated/ams.core.param.RParam.update.rst

@@ -1,6 +0,0 @@
-RParam.update
-=============
-
-.. currentmodule:: ams.core.param
-
-.. automethod:: RParam.update

docs/source/_generated/_generated/ams.core.param.RParam.v.rst

@@ -1,6 +0,0 @@
-RParam.v
-========
-
-.. currentmodule:: ams.core.param
-
-.. autoproperty:: RParam.v

docs/source/_generated/_generated/ams.core.service.LoadScale.assign_memory.rst

@@ -1,6 +0,0 @@
-LoadScale.assign\_memory
-========================
-
-.. currentmodule:: ams.core.service
-
-.. automethod:: LoadScale.assign_memory

docs/source/_generated/_generated/ams.core.service.LoadScale.class_name.rst

@@ -1,6 +0,0 @@
-LoadScale.class\_name
-=====================
-
-.. currentmodule:: ams.core.service
-
-.. autoproperty:: LoadScale.class_name

docs/source/_generated/_generated/ams.core.service.LoadScale.evaluate.rst

@@ -1,6 +0,0 @@
-LoadScale.evaluate
-==================
-
-.. currentmodule:: ams.core.service
-
-.. automethod:: LoadScale.evaluate

docs/source/_generated/_generated/ams.core.service.LoadScale.get_names.rst

@@ -1,6 +0,0 @@
-LoadScale.get\_names
-====================
-
-.. currentmodule:: ams.core.service
-
-.. automethod:: LoadScale.get_names

docs/source/_generated/_generated/ams.core.service.LoadScale.n.rst

@@ -1,6 +0,0 @@
-LoadScale.n
-===========
-
-.. currentmodule:: ams.core.service
-
-.. autoproperty:: LoadScale.n

docs/source/_generated/_generated/ams.core.service.LoadScale.parse.rst

@@ -1,6 +0,0 @@
-LoadScale.parse
-===============
-
-.. currentmodule:: ams.core.service
-
-.. automethod:: LoadScale.parse

docs/source/_generated/_generated/ams.core.service.LoadScale.shape.rst

@@ -1,6 +0,0 @@
-LoadScale.shape
-===============
-
-.. currentmodule:: ams.core.service
-
-.. autoproperty:: LoadScale.shape

docs/source/_generated/_generated/ams.core.service.LoadScale.size.rst

@@ -1,6 +0,0 @@
-LoadScale.size
-==============
-
-.. currentmodule:: ams.core.service
-
-.. autoproperty:: LoadScale.size

docs/source/_generated/_generated/ams.core.service.LoadScale.update.rst

@@ -1,6 +0,0 @@
-LoadScale.update
-================
-
-.. currentmodule:: ams.core.service
-
-.. automethod:: LoadScale.update