ltbams 1.0.3a1__py3-none-any.whl → 1.0.5__py3-none-any.whl

ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-02-02T08:55:36-0500",
+ "date": "2025-04-09T22:08:11-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "8a697edc2d5ab9e5451fa1d4a5b2bec41d180d4c",
- "version": "1.0.3a1"
+ "full-revisionid": "115b1575b21ff871fe878121b3ca1cb6020b1a93",
+ "version": "1.0.5"
 }
 '''  # END VERSION_JSON
 

ams/core/matprocessor.py

@@ -485,25 +485,6 @@ class MatProcessor:
             If True, use UMFPACK as the solver. Effective only when (`incremental=True`)
             & (`line` contains a single line or `step` is 1). Default is True.
 
-        Parameters
-        ----------
-        line: int, str, list, optional
-            Lines index for which the PTDF is calculated. It takes both single
-            or multiple line indices. Note that if `line` is given, the PTDF will
-            not be stored in the MParam.
-        no_store : bool, optional
-            If False, the PTDF will be stored into `MatProcessor.PTDF._v`.
-        incremental : bool, optional
-            If True, the sparse PTDF will be calculated in chunks to save memory.
-        step : int, optional
-            Step for incremental calculation.
-        no_tqdm : bool, optional
-            If True, the progress bar will be disabled.
-        permc_spec : str, optional
-            How to permute the columns of the matrix for sparsity preservation. (default: 'COLAMD')
-        use_umfpack : bool, optional
-            If True, use UMFPACK as the solver. (default: True)
-
         Returns
         -------
         PTDF : np.ndarray or scipy.sparse.lil_matrix

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,7 +19,11 @@ 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``.
+    1. Devices online status of `StaticGen`, `StaticLoad`, and `Shunt` are considered in the connectivity
+    matrices `Cft`, `Cg`, `Cl`, and `Csh`.
 
     References
     ----------
@@ -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.
+    1. Nodal price ``pi`` is calculated with three parts.
+    1. 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/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

docs/source/examples/index.rst

@@ -31,4 +31,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

@@ -6,17 +6,29 @@ Release notes
 
 The APIs before v3.0.0 are in beta and may change without prior notice.
 
-Pre-v1.0.0
+v1.0
 ==========
 
-v1.0.3 (2024-xx-xx)
+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)
+--------------------
 
+- Fix format in release notes
+- Add badges of GitHub relesase and commits in README
+- Add a demo to show sensitivity matrices calculation
+
+v1.0.3 (2024-03-17)
 --------------------
 
 - Bug fix in function ``ams.interface.parse_addfile``, released in v1.0.3a1
 
 v1.0.2 (2024-02-01)
-
 --------------------
 
 - Enhance the GitHub Actions workflow file
@@ -41,6 +53,9 @@ v1.0.0 (2024-01-24)
 - Deprecate method ``get_idx`` and suggest using ``get_all_idxes`` instead
 - Remove module ``benchmarks.py`` and its tests for simplicity
 
+Pre-v1.0
+==========
+
 v0.9.13 (2024-12-05)
 --------------------
 

{ltbams-1.0.3a1.dist-info → ltbams-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.3a1
+Version: 1.0.5
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -33,11 +33,17 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 [![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://github.com/CURENT/ams/blob/master/LICENSE)
 ![platforms](https://anaconda.org/conda-forge/ltbams/badges/platforms.svg)
 [![Python Versions](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/)
+[![DOI:10.1109/TSTE.2025.3528027](https://zenodo.org/badge/DOI/10.1109/TSTE.2025.3528027.svg)](https://ieeexplore.ieee.org/document/10836855)
 [![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)
-![Repo Size](https://img.shields.io/github/repo-size/CURENT/ams)
+[![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)](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/)
+
 [![libraries](https://img.shields.io/librariesio/release/pypi/ltbams)](https://libraries.io/pypi/ltbams)
+![Repo Size](https://img.shields.io/github/repo-size/CURENT/ams)
 [![Structure](https://img.shields.io/badge/code_base-visualize-blue)](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=CURENT%2Fams)
 
 [![Compatibility Tests](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml)
@@ -146,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
 
@@ -212,4 +218,4 @@ Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX,
 [Binder]:                https://mybinder.org/v2/gh/curent/ams/master
 [LTB Repository]:        https://github.com/CURENT
 [benchmark]:             https://github.com/CURENT/demo/tree/master/demo/ams_benchmark
-[paper]:                 https://ieeexplore.ieee.org/document/9169830
+[paper]:                 https://ieeexplore.ieee.org/document/10836855

{ltbams-1.0.3a1.dist-info → ltbams-1.0.5.dist-info}/RECORD

@@ -1,6 +1,6 @@
 ams/__init__.py,sha256=dKIwng8xES4NQHn6ZHy8RCKeXphN9z2wyfmbvniIEg0,351
 ams/__main__.py,sha256=EB4GfGiKgvnQ_psNr0QwPoziYvjmGvQ2yVsBwQtfrLw,170
-ams/_version.py,sha256=jA4hGqiTxLiBPzRLM8URDRE3F6wZ9myl6bTEt2GKIkQ,499
+ams/_version.py,sha256=fHaf3d1VKT7Y8k0GYj2TxX2ZeGzQ92qYr2or0jwPTXM,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
@@ -38,7 +38,7 @@ ams/cases/wecc/wecc.m,sha256=8Wqal6H5r1wNxLLQBCXo2V3v3JZY5IJDEkyrEGCrCWE,30498
 ams/cases/wecc/wecc_uced.xlsx,sha256=R3tZgxEqz_ctKcjA1wwFecxn-QZXutvf7NzgnCg_078,94767
 ams/core/__init__.py,sha256=OUJFLACc9Ggjvzi6DZfmfxrzciRcGtpLTsBfdbOUxGg,80
 ams/core/documenter.py,sha256=FNkpiP65iO809B4Bgmp5C1QeJTQHi-sS9vTP7Wd9D8Q,23131
-ams/core/matprocessor.py,sha256=R3nsA3irZz4cTQMQxE0TXWw9-LucW9PsEMmphA80xns,27608
+ams/core/matprocessor.py,sha256=fkfEE2-PcIuwgeDujyWdW-KNf-JUFhIAOkoWqMAHbnw,26700
 ams/core/model.py,sha256=vXLActAi9tLXRCNd5RrEMVWvF0Wt4mwltiRY5CjgrP4,10928
 ams/core/param.py,sha256=LPH48xUHyqWqODD6IsiamUtkJDDSgGCEMAo6vroFoHE,11130
 ams/core/service.py,sha256=bCeBKoVBd42UVGvjP1dU6DpP6LBW5FGWq3bbOHYSlCI,27984
@@ -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,17 +102,18 @@ 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=6qI1nDf8LepgaHL9HnP1y6a5lGsJAWKQaL7wD7WLbJU,11070
+ams/routines/dcopf2.py,sha256=EtzA1ZQVO4KGVoRdhagV8aIipecWJnXvHYeYTCfgMos,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/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
@@ -126,12 +127,12 @@ docs/source/conf.py,sha256=ozLsGWVbFOZZfruXlvL6ou8i-R8kyCYZedtDzSQVRoU,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=Xna3XJePxxdJxoSAUXQJXwwfKhug0AqQH4OERU3qAxw,12712
+docs/source/release-notes.rst,sha256=se_oKj_P3jyvKEDmnttAv78pmSpvKBjpZLMUg7B8_Q0,13125
 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=6yYgETu_4VQ9x8Jmff5i6pXX4_DLrLpSIRIidhVvqPA,912
 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
@@ -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.3a1.dist-info/METADATA,sha256=zvi17maPhlfJkiEqd-5cxzN7ussINfOaCHJ7_8CdF4o,13417
-ltbams-1.0.3a1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ltbams-1.0.3a1.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
-ltbams-1.0.3a1.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
-ltbams-1.0.3a1.dist-info/RECORD,,
+ltbams-1.0.5.dist-info/METADATA,sha256=Ozov3I100t3YStip3CYXb56cb96APz1juduPF1P2YnY,14023
+ltbams-1.0.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ltbams-1.0.5.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
+ltbams-1.0.5.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
+ltbams-1.0.5.dist-info/RECORD,,

{ltbams-1.0.3a1.dist-info → ltbams-1.0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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)