ltbams 0.9.13__tar.gz → 1.0.1__tar.gz

{ltbams-0.9.13 → ltbams-1.0.1}/LICENSE

@@ -1,6 +1,6 @@
 AMS: Python Software for Scheduling Modeling and Co-Simulation with Dynanic
 
-Copyright (c) 2023-2024 Jinning Wang
+Copyright (c) 2023-2025 Jinning Wang
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

{ltbams-0.9.13/ltbams.egg-info → ltbams-1.0.1}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: ltbams
-Version: 0.9.13
-Summary: Python software for scheduling modeling and co-simulation with dynanics.
+Version: 1.0.1
+Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
-Author-email: jinninggm@gmail.com
-License: GNU Public License v3
-Platform: UNKNOWN
+Author-email: Jinning Wang <jinninggm@gmail.com>
+License: GPL-3.0-or-later
 Classifier: Development Status :: 4 - Beta
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
@@ -14,24 +13,8 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 or later (G
 Classifier: Environment :: Console
 Description-Content-Type: text/markdown
 Provides-Extra: all
-Provides-Extra: coverage             
 Provides-Extra: dev
 Provides-Extra: doc
-Provides-Extra: flake8               
-Provides-Extra: ipython              
-Provides-Extra: myst-parser          
-Provides-Extra: nbsphinx             
-Provides-Extra: numpydoc             
-Provides-Extra: pandoc               
-Provides-Extra: pydata-sphinx-theme  
-Provides-Extra: pyscipopt            
-Provides-Extra: pytest               
-Provides-Extra: pytest-cov           
-Provides-Extra: sphinx               
-Provides-Extra: sphinx-copybutton    
-Provides-Extra: sphinx-panels        
-Provides-Extra: toml                 
-License-File: LICENSE
 
 # LTB AMS
 
@@ -64,12 +47,14 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 
 # Why AMS
 
-With the built-in interface with ANDES, AMS enables **Dynamics Incorporated**
-**Stability-Constrained Scheduling**.
+AMS facilitates **Dynamics Incorporated Scheduling** and **Scheduling-Dynamics Co-Simulation**
+through an integrated interface with ANDES.
 
-This package can be helpful for power system engineers, researchers, and students
-who need to conduct scheduling studies and transient stability studies at given
-operating points.
+This package is helpful for power system engineers, researchers, and students conducting
+scheduling and transient stability studies at specific operating points. It also benefits
+those interested in developing new scheduling formulations and algorithms, particularly
+by extending existing formulations to include new decision variables, constraints, and
+objective functions.
 
 AMS is a **Modeling Framework** that provides a descriptive way to formulate
 scheduling problems. The optimization problems are then handled by **CVXPY**
@@ -78,15 +63,35 @@ and solved with third-party solvers.
 AMS produces credible scheduling results and competitive performance.
 The following results show the comparison of DCOPF between AMS and other tools.
 
-| Cost [\$]       |      AMS       |  MATPOWER   | pandapower |
-|----------------:|--------------:|------------:|-----------:|
-| PEGASE 1354-Bus |  1,173,590.63  |  1,173,590.63 |  1,173,590.63 |
-| PEGASE 2869-Bus |  2,338,915.61  |  2,338,915.61 |  2,338,915.61 |
-| GOC 4020-Bus    |    793,634.11  |    793,634.11 |    793,634.11 |
-| EPIGRIDS 5658-Bus| 1,195,466.12  |  1,195,466.12 |  1,195,466.12 |
-| EPIGRIDS 7336-Bus| 1,855,870.94  |  1,855,870.94 |  1,855,870.94 |
-
-<img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="400" height="auto">
+| Cost [\$]             | AMS          | pandapower   | MATPOWER     |
+|-----------------------|--------------|--------------|--------------|
+| IEEE 14-Bus           | 7,642.59     | 7,642.59     | 7,642.59     |
+| IEEE 39-Bus           | 41,263.94    | 41,263.94    | 41,263.94    |
+| PEGASE 89-Bus         | 5,733.37     | 5,733.37     | 5,733.37     |
+| IEEE 118-Bus          | 125,947.88   | 125,947.88   | 125,947.88   |
+| NPCC 140-Bus          | 810,033.37   | 810,016.06   | 810,033.37   |
+| WECC 179-Bus          | 411,706.13   | 411,706.13   | 411,706.13   |
+| IEEE 300-Bus          | 706,292.32   | 706,292.32   | 706,292.32   |
+| PEGASE 1354-Bus       | 1,218,096.86 | 1,218,096.86 | 1,218,096.86 |
+| PEGASE 2869-Bus       | 2,386,235.33 | 2,386,235.33 | 2,386,235.33 |
+| GOC 4020-Bus          | 793,634.11   | 793,634.11   | 793,634.11   |
+| EPIGRIDS 5658-Bus     | 1,195,466.12 | 1,195,466.12 | 1,195,466.12 |
+| EPIGRIDS 7336-Bus     | 1,855,870.94 | 1,855,870.94 | 1,855,870.94 |
+
+<div style="text-align: left;">
+  <img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="480" height="auto">
+  <p><strong>Figure:</strong> Computation time of OPF on small-scale cases.</p>
+</div>
+
+In the bar chart, the gray bar labeled "AMS Symbolic Processing" represents the time spent
+on symbolic processing, while the wheat-colored bar "AMS Numeric Evaluation" represents the
+time spent on system matrices calculation and optimization model construction.
+The orange bar labeled "AMS GUROBI" represents the optimization-solving time using the GUROBI solver.
+Similarly, the red bar labeled "AMS MOSEK" and the pink bar labeled "AMS PIQP" represent the
+time used by the solvers MOSEK and PIQP, respectively.
+Regarding the baselines, the blue and green bars represent the running time of MATPOWER using
+solver MIPS and pandapower using solver PIPS, respectively.
+The results for AMS, pandapower, and matpower are the average time consumed over ten repeat tests.
 
 AMS is currently under active development.
 Use the following resources to get involved.
@@ -99,16 +104,11 @@ Use the following resources to get involved.
 -  Submit contributions using [pull requests][GitHub pull requests]
 -  Read release notes highlighted [here][release notes]
 -  Try in Jupyter Notebook on [Binder][Binder]
-<!-- + Check out and and cite our [paper][arxiv paper] -->
+-  Check out the source code used for [benchmark][benchmark]
+-  Check out and and cite our [paper][paper]
 
 # Installation
 
-***NOTE:***
-- Version **0.9.9** has known issues and has been yanked from PyPI
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
-- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
-- If solver `SCIP` run into import error, try to reinstall its Python interface by running `pip install pyscipopt --no-binary scip --force`
-
 AMS is released as ``ltbams`` on PyPI and conda-forge.
 Install from PyPI using pip:
 
@@ -128,6 +128,13 @@ Install from GitHub source:
 pip install git+https://github.com/CURENT/ams.git
 ```
 
+***NOTE:***
+- Version **0.9.9** has known issues and has been yanked from PyPI
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `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`
+- Version **1.0.0** is only available on PyPI
+
 # Example Usage
 
 ```python
@@ -149,6 +156,13 @@ sa
 >>> <andes.system.System at 0x14bd98190>
 ```
 
+# Citing AMS
+If you use AMS for research or consulting, please cite the following paper in your publication that uses AMS:
+
+```
+J. Wang et al., "Dynamics-incorporated Modeling Framework for Stability Constrained Scheduling Under High-penetration of Renewable Energy," in IEEE Transactions on Sustainable Energy, doi: 10.1109/TSTE.2025.3528027.
+```
+
 # Sponsors and Contributors
 AMS is the scheduling simulation engine for the CURENT Largescale Testbed (LTB).
 More information about CURENT LTB can be found at the [LTB Repository][LTB Repository].
@@ -184,4 +198,5 @@ Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX,
 [verification]:          https://github.com/CURENT/ams/tree/master/examples/verification
 [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

{ltbams-0.9.13 → ltbams-1.0.1}/README.md

@@ -29,12 +29,14 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 
 # Why AMS
 
-With the built-in interface with ANDES, AMS enables **Dynamics Incorporated**
-**Stability-Constrained Scheduling**.
+AMS facilitates **Dynamics Incorporated Scheduling** and **Scheduling-Dynamics Co-Simulation**
+through an integrated interface with ANDES.
 
-This package can be helpful for power system engineers, researchers, and students
-who need to conduct scheduling studies and transient stability studies at given
-operating points.
+This package is helpful for power system engineers, researchers, and students conducting
+scheduling and transient stability studies at specific operating points. It also benefits
+those interested in developing new scheduling formulations and algorithms, particularly
+by extending existing formulations to include new decision variables, constraints, and
+objective functions.
 
 AMS is a **Modeling Framework** that provides a descriptive way to formulate
 scheduling problems. The optimization problems are then handled by **CVXPY**
@@ -43,15 +45,35 @@ and solved with third-party solvers.
 AMS produces credible scheduling results and competitive performance.
 The following results show the comparison of DCOPF between AMS and other tools.
 
-| Cost [\$]       |      AMS       |  MATPOWER   | pandapower |
-|----------------:|--------------:|------------:|-----------:|
-| PEGASE 1354-Bus |  1,173,590.63  |  1,173,590.63 |  1,173,590.63 |
-| PEGASE 2869-Bus |  2,338,915.61  |  2,338,915.61 |  2,338,915.61 |
-| GOC 4020-Bus    |    793,634.11  |    793,634.11 |    793,634.11 |
-| EPIGRIDS 5658-Bus| 1,195,466.12  |  1,195,466.12 |  1,195,466.12 |
-| EPIGRIDS 7336-Bus| 1,855,870.94  |  1,855,870.94 |  1,855,870.94 |
-
-<img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="400" height="auto">
+| Cost [\$]             | AMS          | pandapower   | MATPOWER     |
+|-----------------------|--------------|--------------|--------------|
+| IEEE 14-Bus           | 7,642.59     | 7,642.59     | 7,642.59     |
+| IEEE 39-Bus           | 41,263.94    | 41,263.94    | 41,263.94    |
+| PEGASE 89-Bus         | 5,733.37     | 5,733.37     | 5,733.37     |
+| IEEE 118-Bus          | 125,947.88   | 125,947.88   | 125,947.88   |
+| NPCC 140-Bus          | 810,033.37   | 810,016.06   | 810,033.37   |
+| WECC 179-Bus          | 411,706.13   | 411,706.13   | 411,706.13   |
+| IEEE 300-Bus          | 706,292.32   | 706,292.32   | 706,292.32   |
+| PEGASE 1354-Bus       | 1,218,096.86 | 1,218,096.86 | 1,218,096.86 |
+| PEGASE 2869-Bus       | 2,386,235.33 | 2,386,235.33 | 2,386,235.33 |
+| GOC 4020-Bus          | 793,634.11   | 793,634.11   | 793,634.11   |
+| EPIGRIDS 5658-Bus     | 1,195,466.12 | 1,195,466.12 | 1,195,466.12 |
+| EPIGRIDS 7336-Bus     | 1,855,870.94 | 1,855,870.94 | 1,855,870.94 |
+
+<div style="text-align: left;">
+  <img src="docs/source/images/dcopf_time.png" alt="DCOPF Time" width="480" height="auto">
+  <p><strong>Figure:</strong> Computation time of OPF on small-scale cases.</p>
+</div>
+
+In the bar chart, the gray bar labeled "AMS Symbolic Processing" represents the time spent
+on symbolic processing, while the wheat-colored bar "AMS Numeric Evaluation" represents the
+time spent on system matrices calculation and optimization model construction.
+The orange bar labeled "AMS GUROBI" represents the optimization-solving time using the GUROBI solver.
+Similarly, the red bar labeled "AMS MOSEK" and the pink bar labeled "AMS PIQP" represent the
+time used by the solvers MOSEK and PIQP, respectively.
+Regarding the baselines, the blue and green bars represent the running time of MATPOWER using
+solver MIPS and pandapower using solver PIPS, respectively.
+The results for AMS, pandapower, and matpower are the average time consumed over ten repeat tests.
 
 AMS is currently under active development.
 Use the following resources to get involved.
@@ -64,16 +86,11 @@ Use the following resources to get involved.
 -  Submit contributions using [pull requests][GitHub pull requests]
 -  Read release notes highlighted [here][release notes]
 -  Try in Jupyter Notebook on [Binder][Binder]
-<!-- + Check out and and cite our [paper][arxiv paper] -->
+-  Check out the source code used for [benchmark][benchmark]
+-  Check out and and cite our [paper][paper]
 
 # Installation
 
-***NOTE:***
-- Version **0.9.9** has known issues and has been yanked from PyPI
-- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
-- `cvxpy` versions **below 1.5** are incompatible with `numpy` versions **2.0 and above**
-- If solver `SCIP` run into import error, try to reinstall its Python interface by running `pip install pyscipopt --no-binary scip --force`
-
 AMS is released as ``ltbams`` on PyPI and conda-forge.
 Install from PyPI using pip:
 
@@ -93,6 +110,13 @@ Install from GitHub source:
 pip install git+https://github.com/CURENT/ams.git
 ```
 
+***NOTE:***
+- Version **0.9.9** has known issues and has been yanked from PyPI
+- `kvxopt` is recommended to install via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries
+- `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`
+- Version **1.0.0** is only available on PyPI
+
 # Example Usage
 
 ```python
@@ -114,6 +138,13 @@ sa
 >>> <andes.system.System at 0x14bd98190>
 ```
 
+# Citing AMS
+If you use AMS for research or consulting, please cite the following paper in your publication that uses AMS:
+
+```
+J. Wang et al., "Dynamics-incorporated Modeling Framework for Stability Constrained Scheduling Under High-penetration of Renewable Energy," in IEEE Transactions on Sustainable Energy, doi: 10.1109/TSTE.2025.3528027.
+```
+
 # Sponsors and Contributors
 AMS is the scheduling simulation engine for the CURENT Largescale Testbed (LTB).
 More information about CURENT LTB can be found at the [LTB Repository][LTB Repository].
@@ -148,4 +179,6 @@ Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX,
 [examples]:              https://github.com/CURENT/ams/tree/master/examples
 [verification]:          https://github.com/CURENT/ams/tree/master/examples/verification
 [Binder]:                https://mybinder.org/v2/gh/curent/ams/master
-[LTB Repository]:        https://github.com/CURENT
+[LTB Repository]:        https://github.com/CURENT
+[benchmark]:             https://github.com/CURENT/demo/tree/master/demo/ams_benchmark
+[paper]:                 https://ieeexplore.ieee.org/document/9169830

{ltbams-0.9.13 → ltbams-1.0.1}/ams/__init__.py

@@ -2,7 +2,6 @@ from . import _version
 __version__ = _version.get_versions()['version']
 
 from ams import opt  # NOQA
-from ams import benchmarks  # NOQA
 
 from ams.main import config_logger, load, run  # NOQA
 from ams.system import System  # NOQA

{ltbams-0.9.13 → ltbams-1.0.1}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-12-05T16:49:45-0500",
+ "date": "2025-01-26T22:29:13-0500",
  "dirty": false,
  "error": null,
- "full-revisionid": "db9279e8765429827062032b803c756025c018b2",
- "version": "0.9.13"
+ "full-revisionid": "26601dec804476dfd457ef35d3eb164c8cede2d0",
+ "version": "1.0.1"
 }
 '''  # END VERSION_JSON
 

{ltbams-0.9.13 → ltbams-1.0.1}/ams/cases/5bus/pjm5bus_uced.json

@@ -514,7 +514,7 @@
       "name": 3
     }
   ],
-  "Region": [
+  "Zone": [
     {
       "idx": "ZONE_1",
       "u": 1.0,

{ltbams-0.9.13 → ltbams-1.0.1}/ams/core/matprocessor.py

@@ -262,7 +262,7 @@ class MatProcessor:
         ng = system.StaticGen.n
 
         # bus indices: idx -> uid
-        idx_gen = system.StaticGen.get_idx()
+        idx_gen = system.StaticGen.get_all_idxes()
         u_gen = system.StaticGen.get(src='u', attr='v', idx=idx_gen)
         on_gen = np.flatnonzero(u_gen)  # uid of online generators
         on_gen_idx = [idx_gen[i] for i in on_gen]  # idx of online generators

{ltbams-0.9.13 → ltbams-1.0.1}/ams/core/model.py

@@ -15,6 +15,8 @@ from andes.utils.func import list_flatten
 from ams.core.documenter import Documenter
 from ams.core.var import Algeb
 
+from ams.utils.misc import deprec_get_idx
+
 logger = logging.getLogger(__name__)
 
 
@@ -51,10 +53,6 @@ class Model:
                                      )))
         self.docum = Documenter(self)
 
-        # TODO: duplicate from ANDES, disable for now
-        # self.syms = SymProcessor(self)  # symbolic processor instance
-        # self.docum = Documenter(self)
-
     def _all_vars(self):
         """
         An OrderedDict of States, ExtStates, Algebs, ExtAlgebs
@@ -212,17 +210,17 @@ class Model:
         self.__dict__[src].__dict__[attr][uid] = value
         return True
 
-    def alter(self, src, idx, value):
+    def alter(self, src, idx, value, attr='v'):
         """
         Alter values of input parameters or constant service.
 
         If the method operates on an input parameter, the new data should be in
-        the same base as that in the input file. This function will convert the
-        new value to per unit in the system base.
+        the same base as that in the input file. This function will convert
+        ``value`` to per unit in the system base whenever necessary.
 
-        The values for storing the input data, i.e., the ``vin`` field of the
-        parameter, will be overwritten, thus the update will be reflected in the
-        dumped case file.
+        The values for storing the input data, i.e., the parameter's ``vin``
+        field, will be overwritten. As a result, altered values will be
+        reflected in the dumped case file.
 
         Parameters
         ----------
@@ -232,14 +230,31 @@ class Model:
             The device to alter
         value : float
             The desired value
+        attr : str
+            The attribute to alter, default is 'v'.
+
+        Notes
+        -----
+        New in version 0.9.14: Added the signature `attr` to alter specific attributes.
+        This feature is useful when you need to manipulate parameter values in the system
+        base and ensure that these changes are reflected in the dumped case file.
         """
+
         instance = self.__dict__[src]
 
         if hasattr(instance, 'vin') and (instance.vin is not None):
-            self.set(src, idx, 'vin', value)
-            instance.v[:] = instance.vin * instance.pu_coeff
-        else:
+            uid = self.idx2uid(idx)
+            if attr == 'vin':
+                self.set(src, idx, 'vin', value / instance.pu_coeff[uid])
+                self.set(src, idx, 'v', value=value)
+            else:
+                self.set(src, idx, 'vin', value)
+                self.set(src, idx, 'v', value * instance.pu_coeff[uid])
+        elif not hasattr(instance, 'vin') and attr == 'vin':
+            logger.warning(f"{self.class_name}.{src} has no `vin` attribute, changing `v`.")
             self.set(src, idx, 'v', value)
+        else:
+            self.set(src, idx, attr=attr, value=value)
 
     def idx2uid(self, idx):
         """
@@ -286,6 +301,7 @@ class Model:
         """
         return self.docum.get(max_width=max_width, export=export)
 
+    @deprec_get_idx
     def get_idx(self):
         """
         Return the index of the model instance.
@@ -294,6 +310,20 @@ class Model:
         """
         return self.idx.v
 
+    def get_all_idxes(self):
+        """
+        Return all the indexes of this model.
+
+        .. note::
+            New in version 1.0.0. Add to follow the group method ``get_all_idxes``.
+
+        Returns
+        -------
+        list
+            A list of indexes.
+        """
+        return self.idx.v
+
     def __repr__(self):
         dev_text = 'device' if self.n == 1 else 'devices'
 

{ltbams-0.9.13 → ltbams-1.0.1}/ams/core/param.py

@@ -12,6 +12,8 @@ from scipy.sparse import issparse
 
 from ams.opt import Param
 
+from ams.utils.misc import deprec_get_idx
+
 logger = logging.getLogger(__name__)
 
 
@@ -168,7 +170,7 @@ class RParam(Param):
                     out = self._v
             elif self.is_group:
                 out = self.owner.get(src=self.src, attr='v',
-                                     idx=self.owner.get_idx())
+                                     idx=self.owner.get_all_idxes())
             else:
                 src_param = getattr(self.owner, self.src)
                 out = getattr(src_param, 'v')
@@ -180,7 +182,7 @@ class RParam(Param):
                 msg += 'likely a modeling error.'
                 raise AttributeError(msg)
             try:
-                sorted_idx = self.owner.find_idx(keys=self.indexer, values=imodel.get_idx())
+                sorted_idx = self.owner.find_idx(keys=self.indexer, values=imodel.get_all_idxes())
             except AttributeError:
                 sorted_idx = self.owner.idx.v
             except Exception as e:
@@ -237,6 +239,7 @@ class RParam(Param):
         postfix = '' if self.src is None else f'.{self.src}'
         return f'{self.__class__.__name__}: {owner}' + postfix
 
+    @deprec_get_idx
     def get_idx(self):
         """
         Get the index of the parameter.
@@ -252,7 +255,49 @@ class RParam(Param):
         """
         if self.indexer is None:
             if self.is_group:
-                return self.owner.get_idx()
+                return self.owner.get_all_idxes()
+            elif self.owner is None:
+                logger.info(f'Param <{self.name}> has no owner.')
+                return None
+            elif hasattr(self.owner, 'idx'):
+                return self.owner.idx.v
+            else:
+                logger.info(f'Param <{self.name}> owner <{self.owner.class_name}> has no idx.')
+                return None
+        else:
+            try:
+                imodel = getattr(self.rtn.system, self.imodel)
+            except AttributeError:
+                msg = f'Indexer source model <{self.imodel}> not found, '
+                msg += 'likely a modeling error.'
+                raise AttributeError(msg)
+            try:
+                sorted_idx = self.owner.find_idx(keys=self.indexer, values=imodel.get_all_idxes())
+            except AttributeError:
+                msg = f'Indexer <{self.indexer}> not found in <{self.imodel}>, '
+                msg += 'likely a modeling error.'
+                raise AttributeError(msg)
+            return sorted_idx
+
+    def get_all_idxes(self):
+        """
+        Get all the indexes of the parameter.
+
+        .. note::
+            New in version 1.0.0.
+
+        Returns
+        -------
+        idx : list
+            Index of the parameter.
+
+        Notes
+        -----
+        - The value will sort by the indexer if indexed.
+        """
+        if self.indexer is None:
+            if self.is_group:
+                return self.owner.get_all_idxes()
             elif self.owner is None:
                 logger.info(f'Param <{self.name}> has no owner.')
                 return None
@@ -269,7 +314,7 @@ class RParam(Param):
                 msg += 'likely a modeling error.'
                 raise AttributeError(msg)
             try:
-                sorted_idx = self.owner.find_idx(keys=self.indexer, values=imodel.get_idx())
+                sorted_idx = self.owner.find_idx(keys=self.indexer, values=imodel.get_all_idxes())
             except AttributeError:
                 msg = f'Indexer <{self.indexer}> not found in <{self.imodel}>, '
                 msg += 'likely a modeling error.'

{ltbams-0.9.13 → ltbams-1.0.1}/ams/core/service.py

@@ -217,11 +217,11 @@ class LoadScale(ROperationService):
     @property
     def v(self):
         sys = self.rtn.system
-        u_idx = self.u.get_idx()
+        u_idx = self.u.get_all_idxes()
         ue = self.u.owner.get(src='u', attr='v', idx=u_idx)
         u_bus = self.u.owner.get(src='bus', attr='v', idx=u_idx)
         u_zone = sys.Bus.get(src='zone', attr='v', idx=u_bus)
-        u_yloc = np.array(sys.Region.idx2uid(u_zone))
+        u_yloc = np.array(sys.Zone.idx2uid(u_zone))
         p0s = np.multiply(self.sd.v[:, u_yloc].transpose(),
                           (ue * self.u.v)[:, np.newaxis])
         if self.sparse:
@@ -587,12 +587,12 @@ class NumHstack(NumOp):
 class ZonalSum(NumOp):
     """
     Build zonal sum matrix for a vector in the shape of collection model,
-    ``Area`` or ``Region``.
+    ``Area`` or ``Zone``.
     The value array is in the shape of (nr, nc), where nr is the length of
     rid instance idx, and nc is the length of the cid value.
 
     In an IEEE-14 Bus system, we have the zonal definition by the
-    ``Region`` model. Suppose in it we have two regions, "ZONE1" and
+    ``Zone`` model. Suppose in it we have two regions, "ZONE1" and
     "ZONE2".
 
     Follwing it, we have a zonal SFR requirement model ``SFR`` that
@@ -606,7 +606,7 @@ class ZonalSum(NumOp):
     In the `RTED` model, we have the Vars ``pru`` and ``prd`` in the
     shape of generators.
 
-    Then, the Region model has idx ['ZONE1', 'ZONE2'], and the ``gsm`` value
+    Then, the Zone model has idx ['ZONE1', 'ZONE2'], and the ``gsm`` value
     will be [[1, 1, 0, 0, 1], [0, 0, 1, 1, 0]].
 
     Finally, the zonal reserve requirements can be formulated as
@@ -621,7 +621,7 @@ class ZonalSum(NumOp):
     u : Callable
         Input.
     zone : str
-        Zonal model name, e.g., "Area" or "Region".
+        Zonal model name, e.g., "Area" or "Zone".
     name : str
         Instance name.
     tex_name : str
@@ -671,7 +671,7 @@ class ZonalSum(NumOp):
         try:
             ridx = zone_mdl.idx.v
         except AttributeError:
-            ridx = zone_mdl.get_idx()
+            ridx = zone_mdl.get_all_idxes()
 
         row, col = np.meshgrid(self.u.v, ridx)
         # consistency check
@@ -759,7 +759,7 @@ class VarSelect(NumOp):
         group = model = None
         if indexer.model in self.rtn.system.groups.keys():
             group = self.rtn.system.groups[indexer.model]
-            group_idx = group.get_idx()
+            group_idx = group.get_all_idxes()
             try:
                 ref = group.get(src=indexer.src, attr='v', idx=group_idx)
             except AttributeError:
@@ -774,7 +774,7 @@ class VarSelect(NumOp):
             raise AttributeError(f'Indexer source model {indexer.model} has no ref.')
 
         try:
-            uidx = self.u.get_idx()
+            uidx = self.u.get_all_idxes()
         except AttributeError:
             raise AttributeError(f'Input {self.u.name} has no idx, likey a modeling error.')