ltbams 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-05T23:02:48-0400",
+ "date": "2025-04-10T23:17:16-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "af7a4e10ba2e35c4180562cf62f69ba5523c6725",
- "version": "1.0.4"
+ "full-revisionid": "3dbdbfee9ce8361b7975c9333179b88c01560137",
+ "version": "1.0.6"
 }
 '''  # END VERSION_JSON
 

ams/io/matpower.py

@@ -203,6 +203,13 @@ def mpc2system(mpc: dict, system) -> bool:
         gcost_idx = 0
         gen_idx = np.arange(mpc['gen'].shape[0]) + 1
         mpc_cost = mpc['gencost']
+        if mpc_cost[0, 0] == 1:
+            logger.warning("Type 1 gencost detected. "
+                           "This is not supported in AMS. "
+                           "Default type 2 cost parameters will be used as a fallback."
+                           "It is recommended to manually convert the gencost data to type 2.")
+            mpc_cost = np.repeat(np.array([[2, 0, 0, 3, 0, 0, 0]]),
+                                 mpc_cost.shape[0], axis=0)
         for data, gen in zip(mpc_cost, gen_idx):
             # NOTE: only type 2 costs are supported for now
             # type  startup shutdown	n	c2  c1  c0

ams/models/cost.py

@@ -100,6 +100,7 @@ class SRCost(ModelData, Model):
     def __init__(self, system, config):
         ModelData.__init__(self)
         Model.__init__(self, system, config)
+        self.group = 'Cost'
         self.gen = IdxParam(info="static generator index",
                             model='StaticGen',
                             mandatory=True,)
@@ -116,6 +117,7 @@ class NSRCost(ModelData, Model):
     def __init__(self, system, config):
         ModelData.__init__(self)
         Model.__init__(self, system, config)
+        self.group = 'Cost'
         self.gen = IdxParam(info="static generator index",
                             model='StaticGen',
                             mandatory=True,)

ams/opt/exprcalc.py

@@ -8,6 +8,8 @@ import re
 
 import numpy as np
 
+from ams.shared import sps  # NOQA
+
 import cvxpy as cp
 
 from ams.utils import pretty_long_message
@@ -68,7 +70,7 @@ class ExpressionCalc(OptzBase):
         msg = f" - Expression <{self.name}>: {self.code}"
         logger.debug(pretty_long_message(msg, _prefix, max_length=_max_length))
         try:
-            local_vars = {'self': self, 'np': np, 'cp': cp}
+            local_vars = {'self': self, 'np': np, 'cp': cp, 'sps': sps}
             self.optz = self._evaluate_expression(self.code, local_vars=local_vars)
         except Exception as e:
             raise Exception(f"Error in evaluating ExpressionCalc <{self.name}>.\n{e}")

ams/routines/__init__.py

@@ -11,6 +11,7 @@ all_routines = OrderedDict([
     ('cpf', ['CPF']),
     ('acopf', ['ACOPF']),
     ('dcopf', ['DCOPF']),
+    ('dcopf2', ['DCOPF2']),
     ('ed', ['ED', 'EDDG', 'EDES']),
     ('rted', ['RTED', 'RTEDDG', 'RTEDES', 'RTEDVIS']),
     ('uc', ['UC', 'UCDG', 'UCES']),

ams/routines/dcopf.py

@@ -19,13 +19,17 @@ class DCOPF(DCPFBase):
     """
     DC optimal power flow (DCOPF).
 
-    The nodal price is calculated as ``pi`` in ``pic``.
+    Notes
+    -----
+    1. The nodal price is calculated as ``pi`` in ``pic``.
+    2. Devices online status of ``StaticGen``, ``StaticLoad``, and ``Shunt`` are considered in the connectivity
+       matrices ``Cft``, ``Cg``, ``Cl``, and ``Csh``.
 
     References
     ----------
-    1. R. D. Zimmerman, C. E. Murillo-Sanchez, and R. J. Thomas, “MATPOWER: Steady-State Operations, Planning, and
-    Analysis Tools for Power Systems Research and Education,” IEEE Trans. Power Syst., vol. 26, no. 1, pp. 12–19,
-    Feb. 2011
+    1. R. D. Zimmerman, C. E. Murillo-Sanchez, and R. J. Thomas, “MATPOWER: Steady-State
+       Operations, Planning, and Analysis Tools for Power Systems Research and Education,” IEEE
+       Trans. Power Syst., vol. 26, no. 1, pp. 12-19, Feb. 2011
     """
 
     def __init__(self, system, config):
@@ -153,7 +157,7 @@ class DCOPF(DCPFBase):
         Parameters
         ----------
         kloss : float, optional
-            The loss factor for the conversion. Defaults to 1.2.
+            The loss factor for the conversion. Defaults to 1.0.
         """
         exec_time = self.exec_time
         if self.exec_time == 0 or self.exit_code != 0:

ams/routines/dcopf2.py

@@ -0,0 +1,95 @@
+"""
+DCOPF routines.
+"""
+import logging
+
+import numpy as np
+from ams.core.param import RParam
+from ams.core.service import NumOp
+
+from ams.routines.dcopf import DCOPF
+from ams.opt import ExpressionCalc
+
+from ams.shared import sps
+
+
+logger = logging.getLogger(__name__)
+
+
+class DCOPF2(DCOPF):
+    """
+    DC optimal power flow (DCOPF) using PTDF.
+    For large cases, it is recommended to build the PTDF first, especially when incremental
+    build is necessary.
+
+    Notes
+    -----
+    1. This routine requires PTDF matrix.
+    2. Nodal price ``pi`` is calculated with three parts.
+    3. Bus angle ``aBus`` is calculated after solving the problem.
+    """
+
+    def __init__(self, system, config):
+        DCOPF.__init__(self, system, config)
+        self.info = 'DCOPF using PTDF'
+        self.type = 'DCED'
+
+        # NOTE: in this way, we still follow the implementation that devices
+        # connectivity status is considered in connection matrix
+        self.ued = NumOp(u=self.Cl,
+                         name='ued', tex_name=r'u_{e,d}',
+                         info='Effective load connection status',
+                         fun=np.sum, args=dict(axis=0),
+                         no_parse=True)
+        self.uesh = NumOp(u=self.Csh,
+                          name='uesh', tex_name=r'u_{e,sh}',
+                          info='Effective shunt connection status',
+                          fun=np.sum, args=dict(axis=0),
+                          no_parse=True)
+
+        self.PTDF = RParam(info='PTDF',
+                           name='PTDF', tex_name=r'P_{TDF}',
+                           model='mats', src='PTDF',
+                           no_parse=True, sparse=True)
+
+        # --- rewrite Expression plf: line flow---
+        self.plf.e_str = 'PTDF @ (Cg@pg - Cl@pd - Csh@gsh - Pbusinj)'
+
+        # --- rewrite nodal price ---
+        self.Cft = RParam(info='Line connection matrix',
+                          name='Cft', tex_name=r'C_{ft}',
+                          model='mats', src='Cft',
+                          no_parse=True, sparse=True,)
+        self.pilb = ExpressionCalc(info='Congestion price, dual of <plflb>',
+                                   name='pilb',
+                                   model='Line', src=None,
+                                   e_str='plflb.dual_variables[0]')
+        self.piub = ExpressionCalc(info='Congestion price, dual of <plfub>',
+                                   name='piub',
+                                   model='Line', src=None,
+                                   e_str='plfub.dual_variables[0]')
+        self.pib = ExpressionCalc(info='Energy price, dual of <pb>',
+                                  name='pib',
+                                  model='Bus', src=None,
+                                  e_str='pb.dual_variables[0]')
+        pi = 'pb.dual_variables[0] + Cft@(plfub.dual_variables[0] - plflb.dual_variables[0])'
+        self.pi.e_str = pi
+
+    def _post_solve(self):
+        """Calculate aBus"""
+        super()._post_solve()
+        sys = self.system
+        Pbus = sys.mats.Cg._v @ self.pg.v
+        Pbus -= sys.mats.Cl._v @ self.pd.v
+        Pbus -= sys.mats.Csh._v @ self.gsh.v
+        Pbus -= self.Pbusinj.v
+        aBus = sps.linalg.spsolve(sys.mats.Bbus._v, Pbus)
+        slack0_uid = sys.Bus.idx2uid(sys.Slack.bus.v[0])
+        self.aBus.v = aBus - aBus[slack0_uid]
+        return super()._post_solve()
+
+    def init(self, **kwargs):
+        if self.system.mats.PTDF._v is None:
+            logger.warning('PTDF is not available, build it now')
+            self.system.mats.build_ptdf()
+        return super().init(**kwargs)

ams/routines/ed.py

@@ -109,8 +109,7 @@ class MPBase:
 class ED(RTED, MPBase, SRBase):
     """
     DC-based multi-period economic dispatch (ED).
-    Dispath interval ``config.t`` (:math:`T_{cfg}`) is introduced,
-    1 [Hour] by default.
+    Dispath interval ``config.t`` (:math:``T_{cfg}``) is introduced, 1 [Hour] by default.
 
     ED extends DCOPF as follows:
 
@@ -124,7 +123,7 @@ class ED(RTED, MPBase, SRBase):
 
     2. The tie-line flow is not implemented in this model.
 
-    3. `EDTSlot.ug` is used instead of `StaticGen.u` for generator commitment.
+    3. ``EDTSlot.ug`` is used instead of ``StaticGen.u`` for generator commitment.
     """
 
     def __init__(self, system, config):

ams/routines/routine.py

@@ -585,6 +585,8 @@ class RoutineBase:
             True to rebuild the system matrices. Set to False to speed up the process
             if no system matrices are changed.
         """
+        if not self.initialized:
+            return self.init()
         t0, _ = elapsed()
         re_finalize = False
         # sanitize input

ams/routines/uc.py

@@ -70,17 +70,15 @@ class UC(DCOPF, RTEDBase, MPBase, SRBase, NSRBase):
     Notes
     -----
     1. Formulations has been adjusted with interval ``config.t``
-
-    3. The tie-line flow has not been implemented in formulations.
+    2. The tie-line flow has not been implemented in formulations.
 
     References
     ----------
     1. Huang, Y., Pardalos, P. M., & Zheng, Q. P. (2017). Electrical power unit commitment: deterministic and
-    two-stage stochastic programming models and algorithms. Springer.
-
+       two-stage stochastic programming models and algorithms. Springer.
     2. D. A. Tejada-Arango, S. Lumbreras, P. Sánchez-Martín and A. Ramos, "Which Unit-Commitment Formulation
-    is Best? A Comparison Framework," in IEEE Transactions on Power Systems, vol. 35, no. 4, pp. 2926-2936,
-    July 2020, doi: 10.1109/TPWRS.2019.2962024.
+       is Best? A Comparison Framework," in IEEE Transactions on Power Systems, vol. 35, no. 4, pp. 2926-2936,
+       July 2020, doi: 10.1109/TPWRS.2019.2962024.
     """
 
     def __init__(self, system, config):

ams/shared.py

@@ -35,7 +35,7 @@ _prefix = r" - --------------> | "  # NOQA
 _max_length = 80                    # NOQA
 
 # NOTE: copyright
-copyright_msg = 'Copyright (C) 2023-2024 Jinning Wang'
+copyright_msg = 'Copyright (C) 2023-2025 Jinning Wang'
 
 # NOTE: copied from CVXPY documentation, last checked on 2024/10/30, v1.5
 mip_solvers = ['CBC', 'COPT', 'GLPK_MI', 'CPLEX', 'GUROBI',

ams/system.py

@@ -422,6 +422,13 @@ class System(andes_System):
             msg = f"Zero line rates detacted in {adjusted_rate}, "
             msg += f"adjusted to {default_rate}."
             logger.info(msg)
+        # Line max angle difference
+        if np.any(self.Line.amax.v == 0):
+            self.Line.amax.v[self.Line.amax.v == 0] = 2 * np.pi
+            logger.info("Zero line amax detected, adjusted to 2*pi.")
+        if np.any(self.Line.amin.v == 0):
+            self.Line.amin.v[self.Line.amin.v == 0] = -2 * np.pi
+            logger.info("Zero line amin detected, adjusted to -2*pi.")
         # === no device addition or removal after this point ===
         self.calc_pu_coeff()   # calculate parameters in system per units
 

docs/source/conf.py

@@ -67,7 +67,7 @@ language = "en"
 
 # General information about the project.
 project = 'AMS'
-copyright = '2023-2024, Jinning Wang'
+copyright = '2023-2025, Jinning Wang'
 author = 'Jinning Wang'
 
 version = ams.__version__

docs/source/examples/index.rst

@@ -3,10 +3,6 @@
 Examples
 ========
 
-.. _`development demos`: https://github.com/CURENT/ams/tree/master/dev/demo
-
-Refer to the development `development demos`_ for examples prior to preparing this section.
-
 A collection of examples are presented to supplement the tutorial. The
 examples below are identical to the Jupyter Notebook in the ``examples``
 folder of the repository
@@ -31,4 +27,5 @@ folder of the repository
 
    ../_examples/demo/demo_ESD1.ipynb
    ../_examples/demo/demo_AGC.ipynb
-   ../_examples/demo/demo_debug.ipynb
+   ../_examples/demo/demo_debug.ipynb
+   ../_examples/demo/demo_mat.ipynb

docs/source/release-notes.rst

@@ -9,6 +9,19 @@ The APIs before v3.0.0 are in beta and may change without prior notice.
 v1.0
 ==========
 
+v1.0.6 (2024-04-10)
+--------------------
+
+- Enhance handling of Type 1 gencost: Automatically fallback to Type 2 gencost
+- Add parameter correction for zero line angle difference
+
+v1.0.5 (2024-04-09)
+--------------------
+
+- Include sensitivity matrices calculation demo in documentation
+- Add ``DCOPF2``, a PTDF-based DCOPF routine
+- Fix bug when update routine parameters before it is initialized
+
 v1.0.4 (2024-04-05)
 --------------------
 

{ltbams-1.0.4.dist-info → ltbams-1.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.4
+Version: 1.0.6
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -37,7 +37,7 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![codecov](https://codecov.io/gh/CURENT/ams/graph/badge.svg?token=RZI5GLLBQH)](https://codecov.io/gh/CURENT/ams)
 
-![GitHub Tag](https://img.shields.io/github/v/tag/CURENT/ams)
+[![GitHub Tag](https://img.shields.io/github/v/tag/CURENT/ams)](https://github.com/CURENT/ams/tags)
 ![GitHub commits since latest release (branch)](https://img.shields.io/github/commits-since/curent/ams/latest/develop)
 [![GitHub last commit (master)](https://img.shields.io/github/last-commit/CURENT/ams/master?label=last%20commit%20to%20master)](https://github.com/CURENT/ams/commits/master/)
 [![GitHub last commit (develop)](https://img.shields.io/github/last-commit/CURENT/ams/develop?label=last%20commit%20to%20develop)](https://github.com/CURENT/ams/commits/develop/)
@@ -152,7 +152,7 @@ pip install git+https://github.com/CURENT/ams.git
 - `cvxpy` is distributed with the open source solvers CLARABEL, OSQP, and SCS, but MIP-capable solvers need separate installation
 - `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
 - If the solver `SCIP` encounters an import error caused by a missing `libscip.9.1.dylib`, try reinstalling its Python interface by running `pip install pyscipopt --no-binary scip --force`
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries, more detailes can be found in this closed issue [Bug with dependency kvxopt 1.3.2.0](https://github.com/CURENT/andes/issues/508)
 - Versions **1.0.0** and **1.0.1** are only available on PyPI
 - Version **0.9.9** has known issues and has been yanked from PyPI
 

{ltbams-1.0.4.dist-info → ltbams-1.0.6.dist-info}/RECORD

@@ -1,12 +1,12 @@
 ams/__init__.py,sha256=dKIwng8xES4NQHn6ZHy8RCKeXphN9z2wyfmbvniIEg0,351
 ams/__main__.py,sha256=EB4GfGiKgvnQ_psNr0QwPoziYvjmGvQ2yVsBwQtfrLw,170
-ams/_version.py,sha256=QJewH8SVJp4BIef-1_4TgcwsHFkIMiPuupiTKidj58o,497
+ams/_version.py,sha256=oAzDdazRg63AUA2MukEv3uZGF9tr0x-lHYUi17sP_Bg,497
 ams/cli.py,sha256=EyNFXn565gFCppTxpyTZviBdPgUuKtgAPZ4WE6xewRk,6164
 ams/interface.py,sha256=PCR9geO-pvCxXxljWP4u3M-BAdVD5DjA3xvf338g9x8,44487
 ams/main.py,sha256=wzKLe_BeQAUyFh-U1cxQIOwr-rAJM8ppB3EEi6_v2tw,23607
 ams/report.py,sha256=gUscOYpPjuPuruzIXAADaifIZv2BSjmP1oKCuHdD3Vw,11004
-ams/shared.py,sha256=Zdy4-kHKc0_3CzyZKmGyCvpmrJz4Wzs9qnFlk8eyzq0,4159
-ams/system.py,sha256=PbJE5JPc9_O8cXTC10HPdvlD6MyxuL8z6q9dxKHWtCc,25917
+ams/shared.py,sha256=yaO4RUD0T-zCcZeML20vORcaf_dXiwMAvjTriXz1xtg,4159
+ams/system.py,sha256=5P0DZ7eEqQ8yQL_JBEMDYpr5N7QKHB2X5aJOvEkjiv4,26307
 ams/cases/5bus/pjm5bus_demo.xlsx,sha256=srKTX4AkDRUVg_ygChyrQjeX7o0KKPJ9q9zU69xJqdU,31112
 ams/cases/5bus/pjm5bus_jumper.xlsx,sha256=IfcSZ3V2ZgfFqpaPMBMqitUQMgoxKRnyFyMEtqdeysI,28375
 ams/cases/5bus/pjm5bus_uced.json,sha256=0RvkZwZwzXKqr8y9shjEr3qCPGlrBrh6VpGhvYa4pMM,18256
@@ -48,14 +48,14 @@ ams/extension/__init__.py,sha256=5IFTNirDL0uDaUsg05_oociVT9VCy2rhPx1ad4LGveM,65
 ams/extension/eva.py,sha256=wUF8RNxzwas2Q6_xD0k3EVWjmX4kxHmTSkv2inJzaUY,16342
 ams/io/__init__.py,sha256=HLE3aozzXEx-6IBy8WTQVdSCpAZrrR9nX6UqaZ7okTw,3774
 ams/io/json.py,sha256=IurwcZDuKczSbRTpcbQZiIi0ARCrMK6kJ0E3wS8ENy8,2585
-ams/io/matpower.py,sha256=40Ga2TPs57Kysm-dirjos-rnZ47aZHMfj7FXpd6eB08,14064
+ams/io/matpower.py,sha256=Oj3FW-eqcl3H5mnB0U5XG1mtCK0SaxVOkgRXaC6MIKA,14523
 ams/io/psse.py,sha256=w5VKNE6enX0lfKwPI857PRtdpwN39R6IFRIcdbPSpOg,151
 ams/io/pypower.py,sha256=E6_kSNfv1Yyv9oYfFebeNeKaQPlHyRZQpE8F6Y67g8Q,2583
 ams/io/xlsx.py,sha256=7ATW1seyxsGn7d5p5IuSRFHcoCHVVjMu3E7mP1Mc74U,2460
 ams/models/__init__.py,sha256=Y1Igq3AByDI6QjqjWxNDMeTAa2-fdnk2ZX5HtdJO6lY,703
 ams/models/area.py,sha256=AKYU6aJQKsVWRZdvMO7yic-8wZ1GumSTQXgDg5L0THw,899
 ams/models/bus.py,sha256=U0vSegkm-9fqPQS9KMJQU6gpIMX_1GK5O_dvRc8-0P0,1585
-ams/models/cost.py,sha256=xD_UQCnc4WvVH_sU-JUKi6vgY2h7iFa3cLJZVH4GGx0,5860
+ams/models/cost.py,sha256=rmGNj9ztMbqA-OIJj8fNNBh8bdYJSY9hk10vffgxc6k,5916
 ams/models/group.py,sha256=byAp-sfsS7WhCL8L9y6wqljO6zO_u_JomgIv4syvbJA,5602
 ams/models/info.py,sha256=Oh0Xo5J4ZHBsNIkMOzIwv_DegsX1inyuv3Q5CpCfyQw,788
 ams/models/line.py,sha256=6t0_Y6rlD8riHiljThwluiZMtshu9kgd9ti_Px81KgU,8083
@@ -74,7 +74,7 @@ ams/models/static/gen.py,sha256=CZepvqhjmlGWkUwP3goiimvhZx04L2ADzzx1aVbfdDg,6685
 ams/models/static/pq.py,sha256=Ky6vcc_G7K46azn4-xBJD-6Rht_3y6r7gkSpFNXWIx0,2583
 ams/opt/__init__.py,sha256=INsl8yxtOzTKqV9pzVxlL6RSGDRaUDwxpZMY1QROrF4,459
 ams/opt/constraint.py,sha256=ERT9zwjQyGkvDo465Yd0wBexlIhjVmw0MyWq4BWnWoI,5534
-ams/opt/exprcalc.py,sha256=6g_d4aYEvy9uxikEwhGE6cqL4wElD3KQmtScYSAHW68,3887
+ams/opt/exprcalc.py,sha256=oVtjNHzdWvYHV-8PdRehAxjledsQxpxatdNgMLeWS5o,3935
 ams/opt/expression.py,sha256=WrWnYliB61uHA_wQjtYgtAXdpgSN1pNqQmWvzHWSsdE,5569
 ams/opt/objective.py,sha256=W0dQfW5dHNdWEc2DQtWYNGMuhMY6Pu-HTD0n7-izDZA,5519
 ams/opt/omodel.py,sha256=hEtfKoSNssSxHgUDdep79pifNTsywytDTjgGgne7nKM,12750
@@ -102,36 +102,37 @@ ams/pypower/routines/cpf_callbacks.py,sha256=93f3sdibG7FsXOP9EmqX-iTe0_eZmGtH1Jh
 ams/pypower/routines/opf.py,sha256=SNklP0cC8qu-ji1vluEj7DjAtvWDneOEkZWZeMBdd5g,73447
 ams/pypower/routines/opffcns.py,sha256=o8EpvWH32x3vbN9gV7Xi-D6RHQ5V2eB8NT15cZrwX2w,78144
 ams/pypower/routines/pflow.py,sha256=q5RFZ5XuB5YQZk1jpJ5aTUB3DfgPJEGsvWyLDNo5PJo,30697
-ams/routines/__init__.py,sha256=hB0Nr9RWjnp7Jx2Xria0JpRyIlbIIDEcLwXHqF9v0ug,612
+ams/routines/__init__.py,sha256=idfPyMhFr0hkUZjcAEQw14JA5zPHeFe3Vl3p4DCJ5d0,640
 ams/routines/acopf.py,sha256=VZC3qs1G7zE--6XxE_wXv432nj3SV5hcrR8967ogYlg,3835
 ams/routines/cpf.py,sha256=xsrUVjtGQ1b7UCXpwwYihqzTeEGJJKnO9LlX1Tz9Tks,1552
-ams/routines/dcopf.py,sha256=cOkqXnSD70QthATeggZUF5c_1tRskzTq2z9ODmsA1JA,10898
+ams/routines/dcopf.py,sha256=PWAd0xRpgTDysG6OMRVMkBGtUEyjvmmSt8758tXajOw,11091
+ams/routines/dcopf2.py,sha256=sDCP8zqYHDh7s7p9SX6G8QhMfIxCg3VPYJn6r3pRKyo,3620
 ams/routines/dcpf.py,sha256=SswIb7t37ulxe1rjroA7oSa6z01kYjO-x8P1WWOUutM,8237
 ams/routines/dcpf0.py,sha256=gPPfSUzzJbHz_gAEFVyZ3iriEHvLJ-OGpTzhza8FOkA,6811
 ams/routines/dopf.py,sha256=yIn4tdxgb_phdvlHn4kMT9dUP0c_0Lu5kFfyCAUG-tk,6241
-ams/routines/ed.py,sha256=eNo-edm8qNrQCl9aHqBoIPDF6ltH65L7IobghoK7uH4,11646
+ams/routines/ed.py,sha256=eAgAbcnqyqR4UdhlV1VHTu6m99slAZSeEeGvkDp8BXs,11648
 ams/routines/pflow.py,sha256=I4lyXDyprkg_0j3gY5bdkkBA5ImSjnouMzRnuG1yKb8,9435
 ams/routines/pflow0.py,sha256=xocLw94jcl2hh3WwnS_mdUW6dsm3EVjvZptVb814GdE,3521
-ams/routines/routine.py,sha256=QoYxjpItxb7fgPajLoMlGH_TFFgIKgg8Ohhf_WP_SIk,35868
+ams/routines/routine.py,sha256=I98uMg6QCt6bipNYwdgtNMbdw_gWCSNVGokS4UmvkSk,35932
 ams/routines/rted.py,sha256=BWq2XCYP99siBiLNMF0oKiUmxsCAypBPYxTNeCsjz8Y,22197
 ams/routines/type.py,sha256=lvTWSnCYIbRJXIm3HX6jA0Hv-WWYusTOUPfoW8DITlU,3877
-ams/routines/uc.py,sha256=kkYicT1zjD_JmL3HQFe4iBedri1OAHO9-skzjiW21Fc,15625
+ams/routines/uc.py,sha256=KeKuvd6xxRQTvRiJA7MSOUUVKO5_c5654gOms3mGS9M,15632
 ams/utils/__init__.py,sha256=2hAQmWRgmnE-bCGT9cJoW9FkPDMGRiGkbBcUgj-bgjI,122
 ams/utils/misc.py,sha256=Y6tPKpUKJa7bL9alroJuG2UNW9vdQjnfAmKb2EbIls8,2027
 ams/utils/paths.py,sha256=D9VNUwtJtHy-8PFzMnxtQ9HpkOXT6vdVOjfOTuoKGKw,6699
 docs/Makefile,sha256=UKXBFAbKGPt1Xw9J84343v0Mh8ylAZ-tE0uCd74DrQU,725
 docs/make.bat,sha256=9UgKGb4SdP006622fJiFxeFT1BeycYAs6hDbV1xwPy8,804
 docs/source/api.rst,sha256=gDix4Vg_SNUqtijlSmfBktpOrWQMdaj4xsBKrO22dfw,1402
-docs/source/conf.py,sha256=ozLsGWVbFOZZfruXlvL6ou8i-R8kyCYZedtDzSQVRoU,6688
+docs/source/conf.py,sha256=UyoWogZTUNSJU7pQS_JaR28nKddW94zr01LYoIciZZw,6688
 docs/source/genmodelref.py,sha256=IhmF7bDw8BXPvLD8V3WjQNrfc-H07r5iS-_4DHbbp-8,1420
 docs/source/genroutineref.py,sha256=0JyMc2kV5bWrWbSoO6d7o4QgDgG8mVy3JGGQWacJypw,1064
 docs/source/index.rst,sha256=N5phQS5RIyYs-NZo_5yYB8LjvHzOKLeXzRA-M8i-g3Q,2688
-docs/source/release-notes.rst,sha256=VX7Pf8XDe1jrT0jO1eJjoj3hRLkwKt2vId16B-cBPEg,12906
+docs/source/release-notes.rst,sha256=UbY9PEvwT9Z70IvdOU34YI7dQ4MTSfHWz9yZamN5euA,13305
 docs/source/_templates/autosummary/base.rst,sha256=zl3U4baR4a6YjsHyT-x9zCOrHwKZOVUdWn1NPX2u3bc,106
 docs/source/_templates/autosummary/class.rst,sha256=Hv_igCsLsUpM62_zN0nqj6FSfKnS5xLyu8ZldMbfOAk,668
 docs/source/_templates/autosummary/module.rst,sha256=YdbpCudOrEU-JbuSlzGvcOI2hn_KrCM6FW5HcGqkaEE,1113
 docs/source/_templates/autosummary/module_toctree.rst,sha256=sg30OdqFDLyo8Y3hl9V-s2BXb1bzcjjqqWaWi-C3qFM,1126
-docs/source/examples/index.rst,sha256=u6-pMB5ecSpNb3x1QWC6tJ8ACh3M6MjLBc4CVFf2z_0,876
+docs/source/examples/index.rst,sha256=6VT3wVeKk8BWf6pJQtZrmcumW_3jI8esdlzja8scUCA,742
 docs/source/getting_started/copyright.rst,sha256=XBfWvLm7T8p-zh1jkDy1kODvTDcH73AEV_vkiN32A2o,715
 docs/source/getting_started/index.rst,sha256=mcp1NdUwbPoNzpn7Owf5Qzfd6J_--ToU52PjmrbwjBY,1512
 docs/source/getting_started/install.rst,sha256=gE4L0ApiC_mwbjbYtkGW4ilyIAu_Jn-VIeoYlgRiOIw,7268
@@ -159,12 +160,12 @@ tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_1st_system.py,sha256=5PQgI1DeM5yQTFagOPCMbk0eItTH6-M6FC8TMCv-CRY,1007
 tests/test_addressing.py,sha256=MIT713KCqMg0h2o4rBDZsGUrpGadmMlXnrrdq-wB77E,1364
 tests/test_andes_mats.py,sha256=3JQ2xK5B4s42EHxjCcUjJbt1VY3rZPwjkq81ubFlsLQ,1674
-tests/test_case.py,sha256=uR2bP1g9PO812W9tVmBwWGmyBN5ltMynOZz0ZeI82iE,7808
+tests/test_case.py,sha256=zkf5jT314e97Rx_PJXCwmuvaeQDTjJ42zYR6WwJetxE,8606
 tests/test_cli.py,sha256=TtCGBy2e7Ll_2gJTFo9juZtzhaakho_MqkcqhG2w2dk,870
 tests/test_export_csv.py,sha256=rZCafNrVbwDo7ZNC4MrL1gIcrU0c6YVw2q-QGL3O4K4,2921
 tests/test_group.py,sha256=Tq0s9gtenqrv4ws5YNzWxbiF4WgyhtMEAXZfJtew6M4,2699
 tests/test_interface.py,sha256=lXKR8OAsGIg5dV2Uj0UwGAl69hKnc_7EtCYvpP_0rrU,8157
-tests/test_io.py,sha256=ABEtSc7-5aHZZrdVorARRhWIxfSBEzkb5fsiSJluGHA,1087
+tests/test_io.py,sha256=LaNkRXZaItAFHqqXs6CC5iaxTMXiDEFGbwYODcOHPWc,1416
 tests/test_jumper.py,sha256=bdOknplEGnO_tiJc7p3xQvgTe2b6Dz53bOgbFaXKMAI,537
 tests/test_known_good.py,sha256=NBrlAxnVMxIHXR2cWps-Kwjh36fiU4Y-eupspZkM0ks,9670
 tests/test_matp.py,sha256=LkjhqxSFr6oY_ENpduDQ77rhLLBl6RzIHZ2d0m_8i-8,17262
@@ -175,14 +176,15 @@ tests/test_report.py,sha256=B2_ugz5gzF4mDdiba498DrkK9hX4Zfa6KUGW54yCGVE,8069
 tests/test_repr.py,sha256=g7MRdxLcZRI1PlREFdUG_npp0LkcQiJZfOPw1aq0EFM,570
 tests/test_routine.py,sha256=gblLHBQ3DJgYiSGsqGdIGnn-CuEZAEnq9CqhqN5m608,6234
 tests/test_rtn_dcopf.py,sha256=LOfAVFzl2t6oTqTmWhmstu1j9FnpzHxdrplbmb3Y6Mc,3660
+tests/test_rtn_dcopf2.py,sha256=g0MOW8J6WPJPQAV3Xwufa3dWEEeH-cQDErzvb-cq8lE,3747
 tests/test_rtn_dcpf.py,sha256=QC6F_4LOZ7mrWOEM3s6a6j-eUDM_n49MQouPIR6fzR0,2555
 tests/test_rtn_ed.py,sha256=2CO0kg3LEN8q75_4Z0cgGz4DTOPUjRHur6Dbfw2tRLQ,10173
 tests/test_rtn_pflow.py,sha256=aDL5Ewm6lWqpdHqIIu-DTllhXzt4bMjsLJaKbJa8sXQ,6990
 tests/test_rtn_rted.py,sha256=AyW5B4A51L_nIVLX1eYeu9ZUboOh1CH2FVj2C1XJjSc,9769
 tests/test_rtn_uc.py,sha256=vdG2ss3q91CXLZ2sUgzoUr1NU-63ue7nOxAYywMordE,8286
 tests/test_service.py,sha256=8YIa_PXurwgOzsWvUqoyqS_AzlpdrKHIMxAln5fIqCU,2438
-ltbams-1.0.4.dist-info/METADATA,sha256=bIJkTtYXfycQdXFyh9018Jkp2aqxwXSc0jJYsr100i0,13855
-ltbams-1.0.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-ltbams-1.0.4.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
-ltbams-1.0.4.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
-ltbams-1.0.4.dist-info/RECORD,,
+ltbams-1.0.6.dist-info/METADATA,sha256=HPawZwqPMnM1vtyrVEA_yU8FDcs47BdNv_zJTaYy5uo,14023
+ltbams-1.0.6.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ltbams-1.0.6.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
+ltbams-1.0.6.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
+ltbams-1.0.6.dist-info/RECORD,,

tests/test_case.py

@@ -264,3 +264,30 @@ class TestCaseInit(unittest.TestCase):
 
         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_io.py

@@ -30,3 +30,12 @@ class TestMATPOWER(unittest.TestCase):
         # In case14.m, the gencost has type 2 cost model, with 3 parameters.
         np.testing.assert_array_less(np.zeros(system14.StaticGen.n),
                                      system14.GCost.c2.v,)
+
+    def test_gencost1(self):
+        """Test when gencost is type 1."""
+        mpcgc1 = self.mpc14.copy()
+        mpcgc1['gencost'] = np.repeat(np.array([[1, 0, 0, 3, 0.01, 40, 0]]), 5, axis=0)
+
+        system = ams.system.System()
+        ams.io.matpower.mpc2system(mpcgc1, system)
+        self.assertEqual(system.GCost.n, 5)

tests/test_rtn_dcopf2.py

@@ -0,0 +1,103 @@
+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.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])
+        # 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)