ltbams 1.0.10__tar.gz → 1.0.11__tar.gz

{ltbams-1.0.10/ltbams.egg-info → ltbams-1.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ltbams
-Version: 1.0.10
+Version: 1.0.11
 Summary: Python software for scheduling modeling and co-simulation with dynamics.
 Home-page: https://github.com/CURENT/ams
 Author: Jinning Wang
@@ -57,21 +57,18 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 
 <img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
 
-|  | Stable | Develop |
-|---|---|---|
-| Documentation | [![Documentation Status](https://readthedocs.org/projects/ams/badge/?version=stable)](https://ams.readthedocs.io/en/stable/?badge=stable) | [![Develop Documentation](https://readthedocs.org/projects/ams/badge/?version=develop)](https://ams.readthedocs.io/en/develop/?badge=develop) |
-
 | Badges |  |  |
 |---|---|---|
 | Repo | ![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg) | ![Repo Size](https://img.shields.io/github/repo-size/CURENT/ams) |
-| Version | ![PyPI Version](https://img.shields.io/pypi/v/ltbams.svg) | ![Conda Version](https://anaconda.org/conda-forge/ltbams/badges/version.svg) |
+| Version | [![PyPI Version](https://img.shields.io/pypi/v/ltbams.svg)](https://pypi.org/project/ltbams/) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/version.svg)](https://anaconda.org/conda-forge/ltbams) |
 | 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) |
-| Download | ![PyPI - Downloads](https://img.shields.io/pypi/dm/ltbams) | ![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/downloads.svg) |
+| 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) |  |
 | 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 Tests](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg) | ![Azure Pipline](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=master) |
-| CD | ![Publish to TestPyPI and PyPI](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg?branch=master) |  |
+| 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) |  |
 | 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) |  |
@@ -237,7 +234,7 @@ See [GitHub contributors][GitHub contributors] for the contributor list.
 AMS is licensed under the [GPL v3 License](./LICENSE).
 
 # Related Projects
-- [Popular Open Source Libraries for Power System Analysis](https://github.com/jinningwang/best-of-ps)
+- [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)
 

{ltbams-1.0.10 → ltbams-1.0.11}/README.md

@@ -7,21 +7,18 @@ Python Software for Power System Scheduling Modeling and Co-Simulation with Dyna
 
 <img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
 
-|  | Stable | Develop |
-|---|---|---|
-| Documentation | [![Documentation Status](https://readthedocs.org/projects/ams/badge/?version=stable)](https://ams.readthedocs.io/en/stable/?badge=stable) | [![Develop Documentation](https://readthedocs.org/projects/ams/badge/?version=develop)](https://ams.readthedocs.io/en/develop/?badge=develop) |
-
 | Badges |  |  |
 |---|---|---|
 | Repo | ![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg) | ![Repo Size](https://img.shields.io/github/repo-size/CURENT/ams) |
-| Version | ![PyPI Version](https://img.shields.io/pypi/v/ltbams.svg) | ![Conda Version](https://anaconda.org/conda-forge/ltbams/badges/version.svg) |
+| Version | [![PyPI Version](https://img.shields.io/pypi/v/ltbams.svg)](https://pypi.org/project/ltbams/) | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/version.svg)](https://anaconda.org/conda-forge/ltbams) |
 | 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) |
-| Download | ![PyPI - Downloads](https://img.shields.io/pypi/dm/ltbams) | ![Anaconda-Server Badge](https://anaconda.org/conda-forge/ltbams/badges/downloads.svg) |
+| 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) |  |
 | 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 Tests](https://github.com/CURENT/ams/actions/workflows/compatibility.yml/badge.svg) | ![Azure Pipline](https://dev.azure.com/curentltb/ams/_apis/build/status%2FCURENT.ams?branchName=master) |
-| CD | ![Publish to TestPyPI and PyPI](https://github.com/CURENT/ams/actions/workflows/publish-pypi.yml/badge.svg?branch=master) |  |
+| 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) |  |
 | 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) |  |
@@ -187,7 +184,7 @@ See [GitHub contributors][GitHub contributors] for the contributor list.
 AMS is licensed under the [GPL v3 License](./LICENSE).
 
 # Related Projects
-- [Popular Open Source Libraries for Power System Analysis](https://github.com/jinningwang/best-of-ps)
+- [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)
 

{ltbams-1.0.10 → ltbams-1.0.11}/ams/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-05-23T00:18:06-0400",
+ "date": "2025-05-23T17:38:11-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "f467fb0017c81d3946c1c566802adc4f411ad05e",
- "version": "1.0.10"
+ "full-revisionid": "6d7b555f5f48c751648594a535711b9fd21d2a85",
+ "version": "1.0.11"
 }
 '''  # END VERSION_JSON
 

{ltbams-1.0.10 → ltbams-1.0.11}/ams/core/documenter.py

@@ -6,26 +6,12 @@ import re
 
 import logging
 from collections import OrderedDict
-from andes.core.documenter import Documenter as andes_Documenter
 from andes.utils.tab import make_doc_table, math_wrap
 
 logger = logging.getLogger(__name__)
 
 
-def disable_method(func):
-    def wrapper(*args, **kwargs):
-        msg = f"Method `{func.__name__}` is included in ANDES Documenter but not supported in AMS Documenter."
-        logger.warning(msg)
-        return None
-    return wrapper
-
-
-def disable_methods(methods):
-    for method in methods:
-        setattr(Documenter, method, disable_method(getattr(Documenter, method)))
-
-
-class Documenter(andes_Documenter):
+class Documenter:
     """
     Helper class for documenting models.
 
@@ -37,16 +23,6 @@ class Documenter(andes_Documenter):
 
     def __init__(self, parent):
         self.parent = parent
-        self.system = parent.system
-        self.class_name = parent.class_name
-        self.config = parent.config
-        self.params = parent.params
-        self.algebs = parent.algebs
-        self.services = parent.services
-
-        func_to_disable = ['_init_doc', '_eq_doc',
-                           '_discrete_doc', '_block_doc']
-        disable_methods(func_to_disable)
 
     def get(self, max_width=78, export='plain'):
         """
@@ -68,14 +44,15 @@ class Documenter(andes_Documenter):
         if export == 'rest':
             max_width = 0
             model_header = '-' * 80 + '\n'
-            out += f'.. _{self.class_name}:\n\n'
+            out += f'.. _{self.parent.class_name}:\n\n'
         else:
             model_header = ''
 
         if export == 'rest':
-            out += model_header + f'{self.class_name}\n' + model_header
+            out += model_header + f'{self.parent.class_name}\n' + model_header
         else:
-            out += model_header + f'Model <{self.class_name}> in Group <{self.parent.group}>\n' + model_header
+            out += model_header + \
+                f'Model <{self.parent.class_name}> in Group <{self.parent.group}>\n' + model_header
 
         if self.parent.__doc__ is not None:
             out += inspect.cleandoc(self.parent.__doc__)
@@ -86,20 +63,35 @@ class Documenter(andes_Documenter):
         out += self._var_doc(max_width=max_width, export=export)
         out += self._service_doc(max_width=max_width, export=export)
         # TODO: fix and add the config doc later on
-        # out += self.config.doc(max_width=max_width, export=export)
+        # out += self.parent.config.doc(max_width=max_width, export=export)
 
         return out
 
     def _var_doc(self, max_width=78, export='plain'):
+        """
+        Export formatted model variable documentation as a string.
+
+        Parameters
+        ----------
+        max_width : int, optional = 80
+            Maximum table width. If export format is ``rest`` it will be unlimited.
+        export : str, optional = 'plain'
+            Export format, 'plain' for plain text, 'rest' for restructuredText.
+
+        Returns
+        -------
+        str
+            Tabulated output in a string
+        """
         # variable documentation
-        if len(self.algebs) == 0:
+        if len(self.parent.algebs) == 0:
             return ''
 
         names, symbols, units = list(), list(), list()
         info = list()
         units_rest, ty = list(), list()
 
-        for p in self.algebs.values():
+        for p in self.parent.algebs.values():
             names.append(p.name)
             ty.append(p.class_name)
             info.append(p.info if p.info else '')
@@ -110,7 +102,7 @@ class Documenter(andes_Documenter):
 
         # replace with latex math expressions if export is ``rest``
         if export == 'rest':
-            symbols = [item.tex_name for item in self.algebs.values()]
+            symbols = [item.tex_name for item in self.parent.algebs.values()]
             symbols = math_wrap(symbols, export=export)
             title = 'Variables\n---------'
 
@@ -132,14 +124,29 @@ class Documenter(andes_Documenter):
                               rest_dict=rest_dict)
 
     def _service_doc(self, max_width=78, export='plain'):
-        if len(self.services) == 0:
+        """
+        Export formatted model service documentation as a string.
+
+        Parameters
+        ----------
+        max_width : int, optional = 80
+            Maximum table width. If export format is ``rest`` it will be unlimited.
+        export : str, optional = 'plain'
+            Export format, 'plain' for plain text, 'rest' for restructuredText.
+
+        Returns
+        -------
+        str
+            Tabulated output in a string
+        """
+        if len(self.parent.services) == 0:
             return ''
 
         names, symbols = list(), list()
         info = list()
         class_names = list()
 
-        for p in self.services.values():
+        for p in self.parent.services.values():
             names.append(p.name)
             class_names.append(p.class_name)
             info.append(p.info if p.info else '')
@@ -165,6 +172,74 @@ class Documenter(andes_Documenter):
                               plain_dict=plain_dict,
                               rest_dict=rest_dict)
 
+    def _param_doc(self, max_width=78, export='plain'):
+        """
+        Export formatted model parameter documentation as a string.
+
+        Parameters
+        ----------
+        max_width : int, optional = 80
+            Maximum table width. If export format is ``rest`` it will be unlimited.
+
+        export : str, optional = 'plain'
+            Export format, 'plain' for plain text, 'rest' for restructuredText.
+
+        Returns
+        -------
+        str
+            Tabulated output in a string
+        """
+        if len(self.parent.params) == 0:
+            return ''
+
+        # prepare temporary lists
+        names, units, class_names = list(), list(), list()
+        info, defaults, properties = list(), list(), list()
+        units_rest = list()
+
+        for p in self.parent.params.values():
+            names.append(p.name)
+            class_names.append(p.class_name)
+            info.append(p.info if p.info else '')
+            defaults.append(p.default if p.default is not None else '')
+            units.append(f'{p.unit}' if p.unit else '')
+            units_rest.append(f'*{p.unit}*' if p.unit else '')
+
+            plist = []
+            for key, val in p.property.items():
+                if val is True:
+                    plist.append(key)
+            properties.append(','.join(plist))
+
+        # symbols based on output format
+        if export == 'rest':
+            symbols = [item.tex_name for item in self.parent.params.values()]
+            symbols = math_wrap(symbols, export=export)
+            title = 'Parameters\n----------'
+        else:
+            symbols = [item.name for item in self.parent.params.values()]
+            title = 'Parameters'
+
+        plain_dict = OrderedDict([('Name', names),
+                                  ('Description', info),
+                                  ('Default', defaults),
+                                  ('Unit', units),
+                                  ('Properties', properties)])
+
+        rest_dict = OrderedDict([('Name', names),
+                                 ('Symbol', symbols),
+                                 ('Description', info),
+                                 ('Default', defaults),
+                                 ('Unit', units_rest),
+                                 ('Properties', properties)])
+
+        # convert to rows and export as table
+        return make_doc_table(title=title,
+                              max_width=max_width,
+                              export=export,
+                              plain_dict=plain_dict,
+                              rest_dict=rest_dict)
+
 
 class RDocumenter:
     """
@@ -172,20 +247,12 @@ class RDocumenter:
 
     Parameters
     ----------
-    parent : Model
-        The `Model` instance to document
+    parent : ams.core.routine.RoutineBase
+        The `RoutineBase` instance to document
     """
 
     def __init__(self, parent):
         self.parent = parent
-        self.system = parent.system
-        self.class_name = parent.class_name
-        self.config = parent.config
-        self.services = parent.services
-        self.rparams = parent.rparams
-        self.vars = parent.vars
-        self.constrs = parent.constrs
-        self.obj = parent.obj
 
     def get(self, max_width=78, export='plain'):
         """
@@ -207,14 +274,15 @@ class RDocumenter:
         if export == 'rest':
             max_width = 0
             model_header = '-' * 80 + '\n'
-            out += f'.. _{self.class_name}:\n\n'
+            out += f'.. _{self.parent.class_name}:\n\n'
         else:
             model_header = ''
 
         if export == 'rest':
-            out += model_header + f'{self.class_name}\n' + model_header
+            out += model_header + f'{self.parent.class_name}\n' + model_header
         else:
-            out += model_header + f'Routine <{self.class_name}> in Type <{self.parent.type}>\n' + model_header
+            out += model_header + \
+                f'Routine <{self.parent.class_name}> in Type <{self.parent.type}>\n' + model_header
 
         if self.parent.__doc__ is not None:
             out += inspect.cleandoc(self.parent.__doc__)
@@ -229,20 +297,20 @@ class RDocumenter:
         out += self._exprc_doc(max_width=max_width, export=export)
         out += self._service_doc(max_width=max_width, export=export)
         out += self._param_doc(max_width=max_width, export=export)
-        out += self.config.doc(max_width=max_width, export=export)
+        out += self.parent.config.doc(max_width=max_width, export=export)
 
         return out
 
     def _service_doc(self, max_width=78, export='plain'):
         # routine service documentation
-        if len(self.services) == 0:
+        if len(self.parent.services) == 0:
             return ''
 
         names, symbols = list(), list()
         info = list()
         class_names = list()
 
-        for p in self.services.values():
+        for p in self.parent.services.values():
             names.append(p.name)
             info.append(p.info if p.info else '')
             class_names.append(p.class_name)
@@ -251,7 +319,7 @@ class RDocumenter:
 
         # replace with latex math expressions if export is ``rest``
         if export == 'rest':
-            symbols = [item.tex_name for item in self.services.values()]
+            symbols = [item.tex_name for item in self.parent.services.values()]
             symbols = math_wrap(symbols, export=export)
             title = 'Services\n---------'
 
@@ -272,13 +340,13 @@ class RDocumenter:
 
     def _constr_doc(self, max_width=78, export='plain'):
         # constraint documentation
-        if len(self.constrs) == 0:
+        if len(self.parent.constrs) == 0:
             return ''
 
         # prepare temporary lists
         names, class_names, info = list(), list(), list()
 
-        for p in self.constrs.values():
+        for p in self.parent.constrs.values():
             names.append(p.name)
             class_names.append(p.class_name)
             info.append(p.info if p.info else '')
@@ -286,7 +354,7 @@ class RDocumenter:
         # expressions based on output format
         expressions = []
         if export == 'rest':
-            for p in self.constrs.values():
+            for p in self.parent.constrs.values():
                 expr = _tex_pre(self, p, self.parent.syms.tex_map)
                 if p.is_eq:
                     expr = f'{expr} = 0'
@@ -460,7 +528,7 @@ class RDocumenter:
         # NOTE: this is for the optimization variables
         # not the _var_doc for ANDES parameters
         # variable documentation
-        if len(self.vars) == 0:
+        if len(self.parent.vars) == 0:
             return ''
 
         # prepare temporary lists
@@ -469,7 +537,7 @@ class RDocumenter:
         sources = list()
         units_rest = list()
 
-        for p in self.vars.values():
+        for p in self.parent.vars.values():
             names.append(p.name)
             class_names.append(p.class_name)
             info.append(p.info if p.info else '')
@@ -493,11 +561,11 @@ class RDocumenter:
 
         # symbols based on output format
         if export == 'rest':
-            symbols = [item.tex_name for item in self.vars.values()]
+            symbols = [item.tex_name for item in self.parent.vars.values()]
             symbols = math_wrap(symbols, export=export)
             title = 'Vars\n----------------------------------'
         else:
-            symbols = [item.name for item in self.vars.values()]
+            symbols = [item.name for item in self.parent.vars.values()]
             title = 'Vars'
 
         plain_dict = OrderedDict([('Name', names),
@@ -536,7 +604,7 @@ class RDocumenter:
         str
             Tabulated output in a string
         """
-        if len(self.rparams) == 0:
+        if len(self.parent.rparams) == 0:
             return ''
 
         # prepare temporary lists
@@ -545,7 +613,7 @@ class RDocumenter:
         sources = list()
         units_rest = list()
 
-        for p in self.rparams.values():
+        for p in self.parent.rparams.values():
             names.append(p.name)
             class_names.append(p.class_name)
             info.append(p.info if p.info else '')
@@ -562,11 +630,11 @@ class RDocumenter:
 
         # symbols based on output format
         if export == 'rest':
-            symbols = [item.tex_name for item in self.rparams.values()]
+            symbols = [item.tex_name for item in self.parent.rparams.values()]
             symbols = math_wrap(symbols, export=export)
             title = 'Parameters\n----------------------------------'
         else:
-            symbols = [item.name for item in self.rparams.values()]
+            symbols = [item.name for item in self.parent.rparams.values()]
             title = 'Parameters'
 
         plain_dict = OrderedDict([('Name', names),

{ltbams-1.0.10 → ltbams-1.0.11}/ams/interface.py

@@ -8,7 +8,7 @@ import logging
 from collections import OrderedDict, Counter
 
 from andes.utils.misc import elapsed
-from andes.system import System as andes_System
+from andes.system import System as adSystem
 
 from ams.utils import create_entry
 from ams.io import input_formats
@@ -107,7 +107,7 @@ def to_andes_pflow(system, no_output=False, default_config=True, **kwargs):
         Additional arguments to be passed to ``andes.system.System()``.
     """
 
-    adsys = andes_System(no_outpu=no_output, default_config=default_config, **kwargs)
+    adsys = adSystem(no_outpu=no_output, default_config=default_config, **kwargs)
     # FIXME: is there a systematic way to do this? Other config might be needed
     adsys.config.freq = system.config.freq
     adsys.config.mva = system.config.mva

{ltbams-1.0.10 → ltbams-1.0.11}/ams/routines/grbopt.py

@@ -10,6 +10,8 @@ import scipy.io
 from andes.shared import np, pd
 from andes.utils.misc import elapsed
 
+from ams.core import Config
+
 from ams.io.pypower import system2ppc
 
 from ams.opt import Var, Objective
@@ -39,9 +41,13 @@ class OPF(DCPF1):
         self.info = 'Optimal Power Flow'
         self.type = 'ACED'
 
+        # Overwrite the config to be empty, as it is not used in this routine
+        self.config = Config(self.class_name)
+
         self.obj = Objective(name='obj',
                              info='total cost, placeholder',
                              e_str='sum(c2 * pg**2 + c1 * pg + c0)',
+                             unit='$',
                              sense='min',)
 
         self.pi = Var(info='Lagrange multiplier on real power mismatch',
@@ -97,23 +103,22 @@ class OPF(DCPF1):
         """
         Run the OPF routine using gurobi-optimods.
 
-        This method invokes `self.solve(**kwargs)`, which internally utilizes
-        `gurobi-optimods` to solve the OPF problem.
+        This method invokes `gurobi-optimods.opf.solve_opf` to solve the OPF problem.
 
-        Keyword arguments
-        -------------------
-        - ``opftype`` : str
+        Parameters
+        ----------
+        - opftype : str
             Type of OPF to solve (default: 'AC').
-        - ``branch_switching`` : bool
+        - branch_switching : bool
             Enable branch switching (default: False).
-        - ``min_active_branches`` : float
+        - min_active_branches : float
             Defines the minimum number of branches that must be turned on when
             branch switching is active, i.e. the minimum number of turned on
             branches is equal to ``numbranches * min_active_branches``. Has no
             effect if ``branch_switching`` is set to False.
-        - ``use_mip_start`` : bool
+        - use_mip_start : bool
             Use MIP start (default: False).
-        - ``time_limit`` : float
+        - time_limit : float
             Time limit for the solver (default: 0.0, no limit).
         """
         if not self.initialized:

{ltbams-1.0.10 → ltbams-1.0.11}/ams/routines/pypower.py

@@ -147,8 +147,8 @@ class DCPF1(RoutineBase):
                        model='Line',)
         # --- objective ---
         self.obj = Objective(name='obj',
-                             info='total cost',
-                             e_str='0',
+                             info='total cost, placeholder',
+                             e_str='0', unit='$',
                              sense='min',)
 
         # --- total cost ---
@@ -346,16 +346,13 @@ class PFlow1(DCPF1):
     It leverages PYPOWER's internal power flow solver and maps results back to the
     AMS system.
 
-    Known Issues
-    ------------
-    - Fast-Decoupled (XB version) and Fast-Decoupled (BX version) algorithms are
-      not fully supported yet.
-
     Notes
     -----
     - This class does not implement the AMS-style power flow formulation.
     - For detailed mathematical formulations and algorithmic details, refer to the
       MATPOWER User's Manual, section on Power Flow.
+    - Fast-Decoupled (XB version) and Fast-Decoupled (BX version) algorithms are
+      not fully supported yet.
     """
 
     def __init__(self, system, config):
@@ -380,7 +377,7 @@ class PFlow1(DCPF1):
                               pf_max_it="maximum number of iterations for Newton's method",
                               pf_max_it_fd="maximum number of iterations for fast decoupled method",
                               pf_max_it_gs="maximum number of iterations for Gauss-Seidel method",
-                              enforce_q_lims="enforce gen reactive power limits, at expense of |V|",
+                              enforce_q_lims="enforce gen reactive power limits, at expense of V magnitude",
                               )
         self.config.add_extra("_alt",
                               pf_alg=(1, 2, 3, 4),
@@ -424,15 +421,12 @@ class DCOPF1(DCPF1):
     function) is always included in the objective, regardless of the generator's
     commitment status. See `pypower/opf_costfcn.py` for implementation details.
 
-    Known Issues
-    ------------
-    - Algorithms 400, 500, 600, and 700 are not fully supported yet.
-
     Notes
     -----
     - This class does not implement the AMS-style DC optimal power flow formulation.
     - For detailed mathematical formulations and algorithmic details, refer to the
       MATPOWER User's Manual, section on Optimal Power Flow.
+    - Algorithms 400, 500, 600, and 700 are not fully supported yet.
     """
 
     def __init__(self, system, config):
@@ -522,10 +516,7 @@ class DCOPF1(DCPF1):
                               scpdipm_red_it=r'o_{scpdipm\_red\_it}',
                               )
 
-        self.obj = Objective(name='obj',
-                             info='total cost, placeholder',
-                             e_str='sum(c2 * pg**2 + c1 * pg + c0)',
-                             sense='min',)
+        self.obj.e_str = 'sum(c2 * pg**2 + c1 * pg + c0)'
 
         self.pi = Var(info='Lagrange multiplier on real power mismatch',
                       name='pi', unit='$/p.u.',

{ltbams-1.0.10 → ltbams-1.0.11}/ams/system.py

@@ -9,7 +9,7 @@ from typing import Dict, Optional
 
 import numpy as np
 
-from andes.system import System as andes_System
+from andes.system import System as adSystem
 from andes.system import (_config_numpy, load_config_rc)
 from andes.variables import FileMan
 
@@ -49,7 +49,7 @@ def disable_methods(methods):
         setattr(System, method, disable_method(getattr(System, method)))
 
 
-class System(andes_System):
+class System(adSystem):
     """
     A subclass of ``andes.system.System``, this class encapsulates data, models,
     and routines for scheduling modeling and analysis in power systems.