ltbams 1.0.5__tar.gz → 1.0.6__tar.gz

{ltbams-1.0.5/ltbams.egg-info → ltbams-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.5
+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

{ltbams-1.0.5 → ltbams-1.0.6}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-09T22:08:11-0400",
+ "date": "2025-04-10T23:17:16-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "115b1575b21ff871fe878121b3ca1cb6020b1a93",
- "version": "1.0.5"
+ "full-revisionid": "3dbdbfee9ce8361b7975c9333179b88c01560137",
+ "version": "1.0.6"
 }
 '''  # END VERSION_JSON
 

{ltbams-1.0.5 → ltbams-1.0.6}/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

{ltbams-1.0.5 → ltbams-1.0.6}/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,)

{ltbams-1.0.5 → ltbams-1.0.6}/ams/routines/dcopf.py

@@ -22,14 +22,14 @@ class DCOPF(DCPFBase):
     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`.
+    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):

{ltbams-1.0.5 → ltbams-1.0.6}/ams/routines/dcopf2.py

@@ -25,8 +25,8 @@ class DCOPF2(DCOPF):
     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.
+    2. Nodal price ``pi`` is calculated with three parts.
+    3. Bus angle ``aBus`` is calculated after solving the problem.
     """
 
     def __init__(self, system, config):

{ltbams-1.0.5 → ltbams-1.0.6}/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):

{ltbams-1.0.5 → ltbams-1.0.6}/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):

{ltbams-1.0.5 → ltbams-1.0.6}/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',

{ltbams-1.0.5 → ltbams-1.0.6}/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
 

{ltbams-1.0.5 → ltbams-1.0.6}/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__

{ltbams-1.0.5 → ltbams-1.0.6}/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

{ltbams-1.0.5 → ltbams-1.0.6}/docs/source/release-notes.rst

@@ -9,6 +9,12 @@ 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)
 --------------------
 

{ltbams-1.0.5 → ltbams-1.0.6/ltbams.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.5
+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

{ltbams-1.0.5 → ltbams-1.0.6}/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)

{ltbams-1.0.5 → ltbams-1.0.6}/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)