ltbams 1.0.13__tar.gz → 1.0.15__tar.gz

{ltbams-1.0.13/ltbams.egg-info → ltbams-1.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.13
+Version: 1.0.15
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -51,12 +51,13 @@ Dynamic: home-page
 
 # LTB AMS
 
+<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+
 Python Software for Power System Scheduling Modeling and Co-Simulation with Dynamics, serving as the market simulator for the [CURENT Largescale Testbed][LTB Repository].
 
 ![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)
 [![DOI:10.1109/TSTE.2025.3528027](https://zenodo.org/badge/DOI/10.1109/TSTE.2025.3528027.svg)](https://ieeexplore.ieee.org/document/10836855)
-
-<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+[![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/174)
 
 | Badges |  |  |
 |---|---|---|
@@ -66,16 +67,16 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 | Tag | [![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) |
 | Documentation | [![Read the Docs](https://img.shields.io/readthedocs/ams?label=stable)](https://ltb.readthedocs.io/projects/ams/en/stable/?badge=stable) | [![Read the Docs](https://img.shields.io/readthedocs/ams?label=develop)](https://ltb.readthedocs.io/projects/ams/en/develop/?badge=develop) |
 | Download | [![PyPI - Downloads](https://img.shields.io/pypi/dm/ltbams)](https://pypi.org/project/ltbams/) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/downloads.svg)](https://anaconda.org/conda-forge/ltbams) |
-| Code Quality | ![Codacy Badge](https://app.codacy.com/project/badge/Grade/69456da1b8634f2f984bd769e35f0050) | ![Codacy Badge](https://app.codacy.com/project/badge/Coverage/69456da1b8634f2f984bd769e35f0050) |
-| Code Cov | ![codecov](https://codecov.io/gh/CURENT/ams/graph/badge.svg?token=RZI5GLLBQH) |  |
+| Quality | ![Codacy Badge](https://app.codacy.com/project/badge/Grade/69456da1b8634f2f984bd769e35f0050) | [![codebeat badge](https://codebeat.co/badges/6c8a53d2-cffd-4787-8c49-d59742a95205)](https://codebeat.co/projects/github-com-curent-ams-master) |
+| Coverage | ![Codacy Badge](https://app.codacy.com/project/badge/Coverage/69456da1b8634f2f984bd769e35f0050) | ![codecov](https://codecov.io/gh/CURENT/ams/graph/badge.svg?token=RZI5GLLBQH) |
 | Last Commit | ![GitHub last commit (master)](https://img.shields.io/github/last-commit/CURENT/ams/master?label=last%20commit%20to%20master) | ![GitHub last commit (develop)](https://img.shields.io/github/last-commit/CURENT/ams/develop?label=last%20commit%20to%20develop) |
-| CI | [![Compatibility](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml) | [![Build Status](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=scuc)](https://dev.azure.com/curentltb/ams/_build/latest?definitionId=2&branchName=scuc) |
-| CD | [![Publish](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml) |  |
+| CI | [![Compatibility](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml) | [![Build Status](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=master)](https://dev.azure.com/curentltb/ams/_build/latest?definitionId=2&branchName=master) |
+| CD | [![Publish](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml) | [![Build Status](https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/ltbams-feedstock?branchName=main)](https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=21708&branchName=main) |
 | Structure | [![Structure](https://img.shields.io/badge/code_base-visualize-blue)](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=CURENT%2Fams) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/CURENT/ams) |
 | Dependency | [![libraries](https://img.shields.io/librariesio/release/pypi/ltbams)](https://libraries.io/pypi/ltbams) |  |
 | Try on Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/curent/ams/master) |  |
 
-# Why AMS
+## Why AMS
 
 AMS facilitates **Dynamics Incorporated Scheduling** and **Scheduling-Dynamics Co-Simulation**
 through an integrated interface with ANDES.
@@ -150,9 +151,9 @@ Use the following resources to get involved.
 -  Read release notes highlighted [here][release notes]
 -  Try in Jupyter Notebook on [Binder][Binder]
 -  Check out the source code used for [benchmark][benchmark]
--  Check out and and cite our [paper][paper]
+-  Check out and cite our [paper][paper]
 
-# Installation
+## Installation
 
 AMS is released as ``ltbams`` on PyPI and conda-forge.
 Install from PyPI using pip:
@@ -191,11 +192,11 @@ 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, more detailes can be found in this closed issue [Bug with dependency kvxopt 1.3.2.0](https://github.com/CURENT/andes/issues/508)
+- For the ImportError related to `kvxopt`, it is recommended to reinstall it via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries. More details 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
 
-# Example Usage
+## Example Usage
 
 ```python
 import ams
@@ -216,12 +217,15 @@ sa
 >>> <andes.system.System at 0x14bd98190>
 ```
 
-# Citing AMS
+Here, RTED stands for Real-Time Economic Dispatch.
+For a full list of acronyms used in the library, please consult the [Documentation - Routine Reference](https://ltb.readthedocs.io/projects/ams/en/stable/routineref.html#routine-reference).
+
+## 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, vol. 16, no. 3, pp. 1673-1685, July 2025, doi: 10.1109/TSTE.2025.3528027.
 
-# Sponsors and Contributors
+## 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].
 
@@ -232,16 +236,9 @@ This work was supported in part by the Advanced Grid Research and Development Pr
 
 See [GitHub contributors][GitHub contributors] for the contributor list.
 
-# License
+## License
 AMS is licensed under the [GPL v3 License](./LICENSE).
 
-# Related Projects
-- [Popular Open Source Libraries for Power System Analysis](https://github.com/ps-wiki/best-of-ps)
-- [G-PST Tools Portal](https://g-pst.github.io/tools/): An open tools portal with a classification approach
-- [Open Source Software (OSS) for Electricity Market Research, Teaching, and Training](https://www2.econ.iastate.edu/tesfatsi/ElectricOSS.htm)
-
-Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX, and MOSEK.
-
 * * *
 
 [GitHub releases]:       https://github.com/CURENT/ams/releases

{ltbams-1.0.13 → ltbams-1.0.15}/README.md

@@ -1,11 +1,12 @@
 # LTB AMS
 
+<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+
 Python Software for Power System Scheduling Modeling and Co-Simulation with Dynamics, serving as the market simulator for the [CURENT Largescale Testbed][LTB Repository].
 
 ![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)
 [![DOI:10.1109/TSTE.2025.3528027](https://zenodo.org/badge/DOI/10.1109/TSTE.2025.3528027.svg)](https://ieeexplore.ieee.org/document/10836855)
-
-<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+[![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/174)
 
 | Badges |  |  |
 |---|---|---|
@@ -15,16 +16,16 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 | Tag | [![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) |
 | Documentation | [![Read the Docs](https://img.shields.io/readthedocs/ams?label=stable)](https://ltb.readthedocs.io/projects/ams/en/stable/?badge=stable) | [![Read the Docs](https://img.shields.io/readthedocs/ams?label=develop)](https://ltb.readthedocs.io/projects/ams/en/develop/?badge=develop) |
 | Download | [![PyPI - Downloads](https://img.shields.io/pypi/dm/ltbams)](https://pypi.org/project/ltbams/) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/downloads.svg)](https://anaconda.org/conda-forge/ltbams) |
-| Code Quality | ![Codacy Badge](https://app.codacy.com/project/badge/Grade/69456da1b8634f2f984bd769e35f0050) | ![Codacy Badge](https://app.codacy.com/project/badge/Coverage/69456da1b8634f2f984bd769e35f0050) |
-| Code Cov | ![codecov](https://codecov.io/gh/CURENT/ams/graph/badge.svg?token=RZI5GLLBQH) |  |
+| Quality | ![Codacy Badge](https://app.codacy.com/project/badge/Grade/69456da1b8634f2f984bd769e35f0050) | [![codebeat badge](https://codebeat.co/badges/6c8a53d2-cffd-4787-8c49-d59742a95205)](https://codebeat.co/projects/github-com-curent-ams-master) |
+| Coverage | ![Codacy Badge](https://app.codacy.com/project/badge/Coverage/69456da1b8634f2f984bd769e35f0050) | ![codecov](https://codecov.io/gh/CURENT/ams/graph/badge.svg?token=RZI5GLLBQH) |
 | Last Commit | ![GitHub last commit (master)](https://img.shields.io/github/last-commit/CURENT/ams/master?label=last%20commit%20to%20master) | ![GitHub last commit (develop)](https://img.shields.io/github/last-commit/CURENT/ams/develop?label=last%20commit%20to%20develop) |
-| CI | [![Compatibility](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml) | [![Build Status](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=scuc)](https://dev.azure.com/curentltb/ams/_build/latest?definitionId=2&branchName=scuc) |
-| CD | [![Publish](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml) |  |
+| CI | [![Compatibility](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/compatibility.yml) | [![Build Status](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=master)](https://dev.azure.com/curentltb/ams/_build/latest?definitionId=2&branchName=master) |
+| CD | [![Publish](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg)](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml) | [![Build Status](https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/ltbams-feedstock?branchName=main)](https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=21708&branchName=main) |
 | Structure | [![Structure](https://img.shields.io/badge/code_base-visualize-blue)](https://mango-dune-07a8b7110.1.azurestaticapps.net/?repo=CURENT%2Fams) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/CURENT/ams) |
 | Dependency | [![libraries](https://img.shields.io/librariesio/release/pypi/ltbams)](https://libraries.io/pypi/ltbams) |  |
 | Try on Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/curent/ams/master) |  |
 
-# Why AMS
+## Why AMS
 
 AMS facilitates **Dynamics Incorporated Scheduling** and **Scheduling-Dynamics Co-Simulation**
 through an integrated interface with ANDES.
@@ -99,9 +100,9 @@ Use the following resources to get involved.
 -  Read release notes highlighted [here][release notes]
 -  Try in Jupyter Notebook on [Binder][Binder]
 -  Check out the source code used for [benchmark][benchmark]
--  Check out and and cite our [paper][paper]
+-  Check out and cite our [paper][paper]
 
-# Installation
+## Installation
 
 AMS is released as ``ltbams`` on PyPI and conda-forge.
 Install from PyPI using pip:
@@ -140,11 +141,11 @@ 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, more detailes can be found in this closed issue [Bug with dependency kvxopt 1.3.2.0](https://github.com/CURENT/andes/issues/508)
+- For the ImportError related to `kvxopt`, it is recommended to reinstall it via `conda` as sometimes ``pip`` struggles to set the correct path for compiled libraries. More details 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
 
-# Example Usage
+## Example Usage
 
 ```python
 import ams
@@ -165,12 +166,15 @@ sa
 >>> <andes.system.System at 0x14bd98190>
 ```
 
-# Citing AMS
+Here, RTED stands for Real-Time Economic Dispatch.
+For a full list of acronyms used in the library, please consult the [Documentation - Routine Reference](https://ltb.readthedocs.io/projects/ams/en/stable/routineref.html#routine-reference).
+
+## 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, vol. 16, no. 3, pp. 1673-1685, July 2025, doi: 10.1109/TSTE.2025.3528027.
 
-# Sponsors and Contributors
+## 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].
 
@@ -181,16 +185,9 @@ This work was supported in part by the Advanced Grid Research and Development Pr
 
 See [GitHub contributors][GitHub contributors] for the contributor list.
 
-# License
+## License
 AMS is licensed under the [GPL v3 License](./LICENSE).
 
-# Related Projects
-- [Popular Open Source Libraries for Power System Analysis](https://github.com/ps-wiki/best-of-ps)
-- [G-PST Tools Portal](https://g-pst.github.io/tools/): An open tools portal with a classification approach
-- [Open Source Software (OSS) for Electricity Market Research, Teaching, and Training](https://www2.econ.iastate.edu/tesfatsi/ElectricOSS.htm)
-
-Some commercial solvers provide academic licenses, such as COPT, GUROBI, CPLEX, and MOSEK.
-
 * * *
 
 [GitHub releases]:       https://github.com/CURENT/ams/releases

{ltbams-1.0.13 → ltbams-1.0.15}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-08-18T15:13:43-0700",
+ "date": "2025-09-28T19:06:51-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "1aab83cb951d517c906fe117499d482da8b6e66b",
- "version": "1.0.13"
+ "full-revisionid": "ae8b4bef43d5202301b5ec84628d164420473a2f",
+ "version": "1.0.15"
 }
 '''  # END VERSION_JSON
 

{ltbams-1.0.13 → ltbams-1.0.15}/ams/cli.py

@@ -23,18 +23,13 @@ command_aliases = {
 
 def create_parser():
     """
-    Create a parser for the command-line interface.
+    Create a parser for the command-line interface,
+    revised from `andes.cli.create_parser`.
 
     Returns
     -------
     argparse.ArgumentParser
         Parser with all AMS options
-
-    Notes
-    -----
-    Revised from the ANDES project (https://github.com/CURENT/andes).
-    Original author: Hantao Cui
-    License: GPL3
     """
 
     parser = argparse.ArgumentParser()

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/common.py

@@ -1,16 +1,20 @@
 import logging
 
-from andes.core.common import Config as AndesConfig
+from andes.core.common import Config as adConfig
 
 logger = logging.getLogger(__name__)
 
 
-class Config(AndesConfig):
+class Config(adConfig):
     """
     A class for storing configuration, can be used in system,
     model, routine, and other modules.
 
-    Revised from `andes.core.common.Config`.
+    Revised from `andes.core.common.Config`, where update method
+    is modified to ensure values in the dictionary are set
+    in the configuration object.
+
+    .. versionadded:: 1.0.11
     """
 
     def __init__(self, name, dct=None, **kwargs):

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/documenter.py

@@ -13,7 +13,8 @@ logger = logging.getLogger(__name__)
 
 class Documenter:
     """
-    Helper class for documenting models.
+    Helper class for documenting models, inspired by
+    `andes.core.documenter.Documenter`.
 
     Parameters
     ----------

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/matprocessor.py

@@ -244,7 +244,7 @@ class MatProcessor:
     The connectivity matrices `Cft`, `Cg`, `Cl`, and `Csh` ***have taken*** the
     devices connectivity into account.
 
-    The MParams' row names and col names are assigned in `System.setup()`.
+    The MParams row names and col names are assigned in `System.setup()`.
     """
 
     def __init__(self, system):
@@ -627,7 +627,7 @@ class MatProcessor:
                 luid = [system.Line.idx2uid(line)]
                 self.PTDF.row_names = [line]
             except ValueError:
-                raise ValueError(f"Line {line} not found.")
+                raise ValueError(f"Line {line} not found.") from None
         elif isinstance(line, list):
             luid = system.Line.idx2uid(line)
             self.PTDF.row_names = line
@@ -725,7 +725,7 @@ class MatProcessor:
             try:
                 luid = [system.Line.idx2uid(line)]
             except ValueError:
-                raise ValueError(f"Line {line} not found.")
+                raise ValueError(f"Line {line} not found.") from None
         elif isinstance(line, list):
             luid = system.Line.idx2uid(line)
 
@@ -811,7 +811,7 @@ class MatProcessor:
             try:
                 luid = [self.system.Line.idx2uid(line)]
             except ValueError:
-                raise ValueError(f"Line {line} not found.")
+                raise ValueError(f"Line {line} not found.") from None
         elif isinstance(line, list):
             luid = self.system.Line.idx2uid(line)
 

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/model.py

@@ -235,9 +235,11 @@ class Model:
 
         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.
+        .. versionchanged:: 0.9.14
+
+        The ``attr`` argument was added to allow altering specific attributes.
+        This is useful when manipulating parameter values in the system base
+        and ensuring that changes are reflected in the dumped case file.
         """
 
         instance = self.__dict__[src]
@@ -307,6 +309,11 @@ class Model:
         Return the index of the model instance.
         Equivalent to ``self.idx.v``, develoepd for consistency with group method
         ``get_idx``.
+
+        Notes
+        -----
+        .. deprecated:: 1.0.0
+           Use ``get_all_idxes`` instead.
         """
         return self.idx.v
 
@@ -314,13 +321,14 @@ class Model:
         """
         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.
+
+        Notes
+        -----
+        .. versionadded:: 1.0.0
         """
         return self.idx.v
 

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/param.py

@@ -252,6 +252,9 @@ class RParam(Param):
         Notes
         -----
         - The value will sort by the indexer if indexed.
+
+        .. deprecated:: 1.0.0
+           Use ``get_all_idxes`` instead.
         """
         if self.indexer is None:
             if self.is_group:
@@ -283,9 +286,6 @@ class RParam(Param):
         """
         Get all the indexes of the parameter.
 
-        .. note::
-            New in version 1.0.0.
-
         Returns
         -------
         idx : list
@@ -294,6 +294,8 @@ class RParam(Param):
         Notes
         -----
         - The value will sort by the indexer if indexed.
+
+        .. versionadded:: 1.0.0
         """
         if self.indexer is None:
             if self.is_group:

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/symprocessor.py

@@ -1,7 +1,13 @@
 """
-Symbolic processor class for AMS routines.
+Symbolic processor class for AMS routines,
+revised from `andes.core.symprocessor`.
 
-This module is revised from ``andes.core.symprocessor``.
+Revised from the ANDES project:
+https://github.com/CURENT/andes
+
+Original author: Hantao Cui
+
+License: GNU General Public License v3.0 (GPL-3.0)
 """
 
 import logging

{ltbams-1.0.13 → ltbams-1.0.15}/ams/core/var.py

@@ -14,7 +14,7 @@ class Algeb:
     """
     Algebraic variable class.
 
-    This class is simplified from ``andes.core.var.Algeb``.
+    Simplified from `andes.core.var.Algeb`.
     """
 
     def __init__(self,

{ltbams-1.0.13 → ltbams-1.0.15}/ams/extension/eva.py

@@ -2,13 +2,6 @@
 EV Aggregator module.
 
 EVD is the generated datasets, and EVA is the aggregator model.
-
-Reference:
-[1] J. Wang et al., "Electric Vehicles Charging Time Constrained Deliverable Provision of Secondary
-Frequency Regulation," in IEEE Transactions on Smart Grid, doi: 10.1109/TSG.2024.3356948.
-[2] M. Wang, Y. Mu, Q. Shi, H. Jia and F. Li, "Electric Vehicle Aggregator Modeling and Control for
-Frequency Regulation Considering Progressive State Recovery," in IEEE Transactions on Smart Grid,
-vol. 11, no. 5, pp. 4176-4189, Sept. 2020, doi: 10.1109/TSG.2020.2981843.
 """
 
 import logging
@@ -50,6 +43,17 @@ class EVD(ModelData, Model):
     """
     In the EVD, each single EV is recorded as a device with its own parameters.
     The parameters are generated from given statistical distributions.
+
+    References
+    ----------
+    1. J. Wang et al., "Electric Vehicles Charging Time Constrained
+       Deliverable Provision of Secondary Frequency Regulation," in IEEE
+       Transactions on Smart Grid, vol. 15, no. 4, pp. 3892-3903, July
+       2024, doi: 10.1109/TSG.2024.3356948.
+    2. M. Wang, Y. Mu, Q. Shi, H. Jia and F. Li, "Electric Vehicle Aggregator
+       Modeling and Control for Frequency Regulation Considering Progressive
+       State Recovery," in IEEE Transactions on Smart Grid, vol. 11, no. 5,
+       pp. 4176-4189, Sept. 2020, doi: 10.1109/TSG.2020.2981843.
     """
 
     def __init__(self, N=10000, Ns=20, Tagc=4, SOCf=0.2, r=0.5,

{ltbams-1.0.13 → ltbams-1.0.15}/ams/interface.py

@@ -177,9 +177,9 @@ def to_andes(system, addfile=None,
 
     Notes
     -----
-    1. Power flow models in the addfile will be skipped and only dynamic models will be used.
-    2. The addfile format is guessed based on the file extension. Currently only ``xlsx`` is supported.
-    3. Index in the addfile is automatically adjusted when necessary.
+    - Power flow models in the addfile will be skipped and only dynamic models will be used.
+    - The addfile format is guessed based on the file extension. Currently only ``xlsx`` is supported.
+    - Index in the addfile is automatically adjusted when necessary.
     """
     t0, _ = elapsed()
 
@@ -446,9 +446,9 @@ class Dynamic:
 
     Notes
     -----
-    1. Using the file conversion ``to_andes()`` will automatically
-       link the AMS system to the converted ANDES system in the
-       attribute ``dyn``.
+    - Using the file conversion ``to_andes()`` will automatically
+      link the AMS system to the converted ANDES system in the
+      attribute ``dyn``.
 
     Examples
     --------
@@ -503,7 +503,7 @@ class Dynamic:
 
         Notes
         -----
-        1. AGC power reference ``paux`` is not included in this function.
+        - AGC power reference ``paux`` is not included in this function.
         """
         # 1) TurbineGov
         syg_idx = sp.dyn.link['syg_idx'].dropna().tolist()  # SynGen idx

{ltbams-1.0.13 → ltbams-1.0.15}/ams/io/json.py

@@ -11,7 +11,9 @@ from collections import OrderedDict
 from andes.io.json import (testlines, read)  # NOQA
 from andes.utils.paths import confirm_overwrite
 
-from ams.shared import empty_adsys, ad_models
+from ams.shared import pd
+from ams.shared import summary_row, summary_name, model2df
+
 
 logger = logging.getLogger(__name__)
 
@@ -24,7 +26,8 @@ def write(system, outfile, skip_empty=True, overwrite=None,
     If to_andes is True, only write models that are in ANDES,
     but the outfile might not be able to be read back into AMS.
 
-    Revise function ``andes.io.json.write`` to skip non-andes models.
+    Revised from `andes.io.json.write`, where non-andes models
+    are skipped if `to_andes` is True.
 
     Parameters
     ----------
@@ -63,20 +66,21 @@ def _dump_system(system, skip_empty, orient='records', to_andes=False):
     them all in an OrderedDict.
     """
     out = OrderedDict()
+    summary_found = False
     for name, instance in system.models.items():
-        if skip_empty and instance.n == 0:
+        df = model2df(instance, skip_empty, to_andes=to_andes)
+        if df is None:
             continue
-        if to_andes:
-            if name not in ad_models:
-                continue
-            # NOTE: ommit parameters that are not in ANDES
-            skip_params = []
-            ams_params = list(instance.params.keys())
-            andes_params = list(empty_adsys.models[name].params.keys())
-            skip_params = list(set(ams_params) - set(andes_params))
-            df = instance.cache.df_in.drop(skip_params, axis=1, errors='ignore')
-            out[name] = df.to_dict(orient=orient)
-        else:
-            df = instance.cache.df_in
-            out[name] = df.to_dict(orient=orient)
+
+        if name == summary_name:
+            df = pd.concat([pd.DataFrame([summary_row]), df], ignore_index=True)
+            df.index.name = "uid"
+            summary_found = True
+        out[name] = df.to_dict(orient=orient)
+
+    if not summary_found:
+        df = pd.DataFrame([summary_row])
+        df.index.name = "uid"
+        out[summary_name] = df.to_dict(orient=orient)
+
     return json.dumps(out, indent=2)

{ltbams-1.0.13 → ltbams-1.0.15}/ams/io/matpower.py

@@ -36,10 +36,11 @@ def read(system, file):
 
 def m2mpc(infile: str) -> dict:
     """
-    Parse a MATPOWER file and return a dictionary containing the parsed data.
+    Parse a MATPOWER file and return a dictionary containing the parsed data,
+    revised from `andes.io.matpower.m2mpc`.
 
     This function processes MATPOWER case files and extracts relevant fields
-    into a structured dictionary. It is revised from ``andes.io.matpower.m2mpc``.
+    into a structured dictionary.
 
     Supported fields include:
     - `baseMVA`: The system base power in MVA.
@@ -181,9 +182,8 @@ def m2mpc(infile: str) -> dict:
 
 def mpc2system(mpc: dict, system) -> bool:
     """
-    Load an mpc dict into an empty AMS system.
-
-    Revised from ``andes.io.matpower.mpc2system``.
+    Load an mpc dict into an empty AMS system, revised from
+    `andes.io.matpower.mpc2system`.
 
     Note that `mbase` in mpc is converted to `Sn`, but it is not actually used in
     MATPOWER nor AMS.
@@ -453,7 +453,7 @@ def system2mpc(system) -> dict:
     """
     Convert a **setup** AMS system to a MATPOWER mpc dictionary.
 
-    This function is revised from ``andes.io.matpower.system2mpc``.
+    Revised from `andes.io.matpower.system2mpc`.
 
     Parameters
     ----------

{ltbams-1.0.13 → ltbams-1.0.15}/ams/io/psse.py

@@ -16,7 +16,8 @@ def read(system, file):
     """
     Read PSS/E RAW file v32/v33 formats.
 
-    Revised from ``andes.io.psse.read`` to complete model ``Zone`` when necessary.
+    Revised from `andes.io.psse.read`, where model ``Zone`` is completed
+    when necessary.
     """
     ret = ad_read(system, file)
     # Extract zone data