ltbams 1.0.10__py3-none-any.whl → 1.0.11__py3-none-any.whl

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
 

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),

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

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:

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.',

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.

ams/utils/paths.py

@@ -184,7 +184,7 @@ def get_pycode_path(pycode_path=None, mkdir=False):
     """
 
     if pycode_path is None:
-        pycode_path = os.path.join(get_dot_andes_path(), 'pycode')
+        pycode_path = os.path.join(get_dot_ams_path(), 'pycode')
 
     if mkdir is True:
         os.makedirs(pycode_path, exist_ok=True)
@@ -203,7 +203,7 @@ def get_pkl_path():
 
     """
     pkl_name = 'calls.pkl'
-    ams_path = get_dot_andes_path()
+    ams_path = get_dot_ams_path()
 
     if not os.path.exists(ams_path):
         os.makedirs(ams_path)
@@ -213,7 +213,7 @@ def get_pkl_path():
     return pkl_path
 
 
-def get_dot_andes_path():
+def get_dot_ams_path():
     """
     Return the path to ``$HOME/.ams``
     """

docs/source/examples/index.rst

@@ -28,4 +28,5 @@ folder of the repository
    ../_examples/demo/demo_ESD1.ipynb
    ../_examples/demo/demo_AGC.ipynb
    ../_examples/demo/demo_debug.ipynb
-   ../_examples/demo/demo_mat.ipynb
+   ../_examples/demo/demo_mat.ipynb
+   ../_examples/demo/demo_wrapper_routines.ipynb

docs/source/genroutineref.py

@@ -7,7 +7,7 @@ import ams
 
 if not (os.path.isfile('routineref.rst') and os.path.isfile('configref.rst')):
 
-    ss = ams.load(ams.get_case('ieee14/ieee14_uced.xlsx'))
+    ss = ams.load(ams.get_case('5bus/pjm5bus_demo.json'))
 
     # write the top-level index file
 

docs/source/release-notes.rst

@@ -9,8 +9,14 @@ The APIs before v3.0.0 are in beta and may change without prior notice.
 v1.0
 ==========
 
-v1.0.10 (2024-xx-xx)
---------------------
+v1.0.11 (2025-05-23)
+----------------------
+
+- Refactor Documenter
+- Fix bug in documentation building
+
+v1.0.10 (2025-05-23)
+----------------------
 
 - Add bus type correction in ``system.System.setup()``
 - Revise ``ams.io.psse.read`` to complete model Zone when necessary
@@ -30,7 +36,7 @@ v1.0.10 (2024-xx-xx)
 - Remove legacy revised PYPOWER module
 - Remove function ``ams.shared.ppc2df``
 
-v1.0.9 (2024-04-23)
+v1.0.9 (2025-04-23)
 --------------------
 
 Improve MATPOWER file converter:
@@ -38,7 +44,7 @@ Improve MATPOWER file converter:
 - Add a M file case writer
 - Include Area and Zone in both MATPOWER read and write
 
-v1.0.8 (2024-04-20)
+v1.0.8 (2025-04-20)
 --------------------
 
 - Run workflow "Publish" only on push tag event
@@ -48,7 +54,7 @@ v1.0.8 (2024-04-20)
 - Include ``gentype`` and ``genfuel`` when parsing MATPOWER cases
 - Fix logging level in ``ACOPF.run``
 
-v1.0.7 (2024-04-14)
+v1.0.7 (2025-04-14)
 --------------------
 
 - Address several wording issues in the documentation
@@ -62,44 +68,44 @@ v1.0.7 (2024-04-14)
   parameters conversion
 - Update case files
 
-v1.0.6 (2024-04-10)
+v1.0.6 (2025-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)
+v1.0.5 (2025-04-09)
 --------------------
 
 - Include sensitivity matrices calculation demo in documentation
 - Add ``DCOPF2``, a PTDF-based DCOPF routine
 - Fix bug when update routine parameters before it is initialized
 
-v1.0.4 (2024-04-05)
+v1.0.4 (2025-04-05)
 --------------------
 
 - Fix format in release notes
 - Add badges of GitHub relesase and commits in README
 - Add a demo to show sensitivity matrices calculation
 
-v1.0.3 (2024-03-17)
+v1.0.3 (2025-03-17)
 --------------------
 
 - Bug fix in function ``ams.interface.parse_addfile``, released in v1.0.3a1
 
-v1.0.2 (2024-02-01)
+v1.0.2 (2025-02-01)
 --------------------
 
 - Enhance the GitHub Actions workflow file
 - Deprecate andes logger configuration in ``config_logger``
 - Deprecate solver specification in ``demo_ESD1``
 
-v1.0.1 (2024-01-26)
+v1.0.1 (2025-01-26)
 --------------------
 
 Hotfix: removed dependencies on `SCIP` and `pyscipopt` to resolve installation issues
 
-v1.0.0 (2024-01-24)
+v1.0.0 (2025-01-24)
 --------------------
 
 - **Breaking Change**: rename model ``Region`` to ``Zone`` for clarity. Prior case

{ltbams-1.0.10.dist-info → ltbams-1.0.11.dist-info}/METADATA

@@ -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.dist-info → ltbams-1.0.11.dist-info}/RECORD

@@ -1,12 +1,12 @@
 ams/__init__.py,sha256=q-9-f0YCg6aaTW19VCkY6VosfvRA2ObI9mF1f_3016Y,313
 ams/__main__.py,sha256=EB4GfGiKgvnQ_psNr0QwPoziYvjmGvQ2yVsBwQtfrLw,170
-ams/_version.py,sha256=kccksMimNEDK-8pkw0RnSVrUE7NGH1_HlY85CE4sJgQ,498
+ams/_version.py,sha256=9w0v2vIzAou5TWcsacfNdhiCAr9S83BM7FAKRy_t8h0,498
 ams/cli.py,sha256=EyNFXn565gFCppTxpyTZviBdPgUuKtgAPZ4WE6xewRk,6164
-ams/interface.py,sha256=-I5dRdHQPxyHBDCp02eYuqyW1aleHwn_nGgTxFYAG1I,45248
+ams/interface.py,sha256=-UN7-TiSt7mOS0W7526LuOk4KCIGDZSguRaVmh_KMRM,45240
 ams/main.py,sha256=lIqC16TO0pye75Wv8l_6EemNtm15iyMdvu8YQFkdd_4,23599
 ams/report.py,sha256=ewcffopOzT5o45eJNmcV8pxeQqPIjKbarGN33-yHGA8,10961
 ams/shared.py,sha256=4sY2U0sghs_S2V6C7Z0OyQ6WZRfpCXk2_Cf_Mg24Vr4,3900
-ams/system.py,sha256=kASxxtA6rQ2mCBdwGXd_M3FRTH8xSXE99h8UCPrMnfU,29773
+ams/system.py,sha256=eAsaXO2O_7_PAIuPFup3edztuAhKMhODrR9l92CYx38,29765
 ams/cases/5bus/pjm5bus_demo.json,sha256=IpxO2vzB9-9Kg9xjOXREKeXEz9wjFE7cuQbcUu8VORA,23152
 ams/cases/5bus/pjm5bus_demo.xlsx,sha256=OWIUprkg8_aQ_bTCaEFMl7Bhfa1R20zxAHXRQtXBix0,32607
 ams/cases/5bus/pjm5bus_ev.xlsx,sha256=vR8dJv5jIxib1pgcMonhzvraoqZVJWhBSJdVXDL0qsI,19498
@@ -37,7 +37,7 @@ ams/cases/wecc/wecc.m,sha256=8Wqal6H5r1wNxLLQBCXo2V3v3JZY5IJDEkyrEGCrCWE,30498
 ams/cases/wecc/wecc_uced.xlsx,sha256=R3tZgxEqz_ctKcjA1wwFecxn-QZXutvf7NzgnCg_078,94767
 ams/core/__init__.py,sha256=lIvrAvYf2yrHWqYi0rVuJgJt8KNA8nTmN2iuZ125z9Q,123
 ams/core/common.py,sha256=934J7xq5JvC14yKp2Z4hWKUFJFhxzAnxB_8_99CChY0,704
-ams/core/documenter.py,sha256=FNkpiP65iO809B4Bgmp5C1QeJTQHi-sS9vTP7Wd9D8Q,23131
+ams/core/documenter.py,sha256=3-jUYrtN8zDZXd8tQZlmZouJluJPH9_xIDbK9ZEEnRU,25762
 ams/core/matprocessor.py,sha256=3eEij-ul8Rx25ZwNbv66YEOKyUXB-fYO-ZQs5BpqmIU,26610
 ams/core/model.py,sha256=LNZtzyf2A7Tz3pn9IDs35JYaHSkQRqhqZicTpZGSqsc,10926
 ams/core/param.py,sha256=LPH48xUHyqWqODD6IsiamUtkJDDSgGCEMAo6vroFoHE,11130
@@ -88,29 +88,29 @@ ams/routines/dcopf2.py,sha256=sDCP8zqYHDh7s7p9SX6G8QhMfIxCg3VPYJn6r3pRKyo,3620
 ams/routines/dcpf.py,sha256=lGZ9LmCL1DsFB-sNxI7NGrq0qd_iBRMDPJmU5022t20,8242
 ams/routines/dopf.py,sha256=8D36-FkPORYGaMnwGTqwz8HxAXk5ywo3mk8NlGq327g,6289
 ams/routines/ed.py,sha256=9Hf_ZqD6poIxCIBfsTMC0DGoPNEja1ZtVxqhb4ijhgE,11875
-ams/routines/grbopt.py,sha256=DeNpm6JU-I_i_Q_vicaz_u_MnrE6zSLeyxcfJOluOoc,5367
+ams/routines/grbopt.py,sha256=RjrMq6XPHeBEbf-Pt9sLk2D1vnXZYYwaic4BP8lbACg,5480
 ams/routines/pflow.py,sha256=5_9n10r_PfsVXIRkaBgKxVITumImZ8mvpHnwxX_ECdw,9432
-ams/routines/pypower.py,sha256=1DjhNpCqhSQdZivYQsNvpBaKUEhmNsiWGgAHdMB7cOk,26740
+ams/routines/pypower.py,sha256=U1UJbcNG7JawGmK9sKtjZlRrGwODVWDjJFucisMcvJs,26545
 ams/routines/routine.py,sha256=v4jzsziQPvbVh5m0AH629NBEtmKlLvitFW5m-YfFtfY,35833
 ams/routines/rted.py,sha256=GOHRxo0-HS5HhwQg8lv7-2VcGr_M_TdUvvomgJ31fDQ,22070
 ams/routines/type.py,sha256=lvTWSnCYIbRJXIm3HX6jA0Hv-WWYusTOUPfoW8DITlU,3877
 ams/routines/uc.py,sha256=VcuNy2TnBjsewKEGIqeo2EFTyuhpx5QsEvgpAtscDIQ,15648
 ams/utils/__init__.py,sha256=2hAQmWRgmnE-bCGT9cJoW9FkPDMGRiGkbBcUgj-bgjI,122
 ams/utils/misc.py,sha256=Y6tPKpUKJa7bL9alroJuG2UNW9vdQjnfAmKb2EbIls8,2027
-ams/utils/paths.py,sha256=D9VNUwtJtHy-8PFzMnxtQ9HpkOXT6vdVOjfOTuoKGKw,6699
+ams/utils/paths.py,sha256=o9Ku2ETmYxsoD7VbMlS4qv_wGtXtT-SWIgDs0F7jpCQ,6693
 docs/Makefile,sha256=UKXBFAbKGPt1Xw9J84343v0Mh8ylAZ-tE0uCd74DrQU,725
 docs/make.bat,sha256=9UgKGb4SdP006622fJiFxeFT1BeycYAs6hDbV1xwPy8,804
 docs/source/api.rst,sha256=BRzdDFDzDwVL7Jr_Xj-O5Icgx0gt5hNNd1OjvPl7ap0,1490
 docs/source/conf.py,sha256=UyoWogZTUNSJU7pQS_JaR28nKddW94zr01LYoIciZZw,6688
 docs/source/genmodelref.py,sha256=IhmF7bDw8BXPvLD8V3WjQNrfc-H07r5iS-_4DHbbp-8,1420
-docs/source/genroutineref.py,sha256=0JyMc2kV5bWrWbSoO6d7o4QgDgG8mVy3JGGQWacJypw,1064
+docs/source/genroutineref.py,sha256=glHhbWUXfZzMDrkque9CBZu8QtdxlxPojInERzAAOwA,1063
 docs/source/index.rst,sha256=N5phQS5RIyYs-NZo_5yYB8LjvHzOKLeXzRA-M8i-g3Q,2688
-docs/source/release-notes.rst,sha256=Fa-rDL0lhaZVi8nwfyn7gCQhQUKyn7NtMIIBkeGM-Vc,13724
+docs/source/release-notes.rst,sha256=7BtbNLQ2EUvSvB9KGNELicPAFqNT8uBzQQLqlT9MpMc,13830
 docs/source/_templates/autosummary/base.rst,sha256=zl3U4baR4a6YjsHyT-x9zCOrHwKZOVUdWn1NPX2u3bc,106
 docs/source/_templates/autosummary/class.rst,sha256=Hv_igCsLsUpM62_zN0nqj6FSfKnS5xLyu8ZldMbfOAk,668
 docs/source/_templates/autosummary/module.rst,sha256=YdbpCudOrEU-JbuSlzGvcOI2hn_KrCM6FW5HcGqkaEE,1113
 docs/source/_templates/autosummary/module_toctree.rst,sha256=sg30OdqFDLyo8Y3hl9V-s2BXb1bzcjjqqWaWi-C3qFM,1126
-docs/source/examples/index.rst,sha256=6VT3wVeKk8BWf6pJQtZrmcumW_3jI8esdlzja8scUCA,742
+docs/source/examples/index.rst,sha256=yXR54WHHcBY38-h9LkdTBcNq3HDeT6eSNyrMmafq12E,792
 docs/source/getting_started/copyright.rst,sha256=d3S7FjrbysVqQd3pEBadrrkcQOZ7sYYeDTCOS4goPC8,715
 docs/source/getting_started/index.rst,sha256=mcp1NdUwbPoNzpn7Owf5Qzfd6J_--ToU52PjmrbwjBY,1512
 docs/source/getting_started/install.rst,sha256=pCL5GDNxwkWnrPaO48i9c0bBPT_dYAWvD2CQ7Oi2P_0,7400
@@ -136,7 +136,7 @@ docs/source/modeling/model.rst,sha256=j7OSvoXnDht6rGpgwPiJklsCWrebfx4DxIN-G8r6iF
 docs/source/modeling/routine.rst,sha256=BkUE3y5L1lA7LP9Nyzc4zzY-tF3t4k7egBE188kybHY,4286
 docs/source/modeling/system.rst,sha256=NMOPNMOKG1_dRyNPPx-MiCKbbpadxWJxGyU6geRUsvQ,1374
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_1st_system.py,sha256=63ngZwXbUzs1964XmqzlkWUgBugi29vuEDMBBTXxLiE,1900
+tests/test_1st_system.py,sha256=WoCgeyUCjBVwyYCqzwDkYy8F3dWArMQBESqIUQk6tOk,1907
 tests/test_addressing.py,sha256=MIT713KCqMg0h2o4rBDZsGUrpGadmMlXnrrdq-wB77E,1364
 tests/test_case.py,sha256=b_YZhwIN9sX3FCMD03hRNygV-mYthNj7cOhEv7-by-g,8857
 tests/test_cli.py,sha256=TtCGBy2e7Ll_2gJTFo9juZtzhaakho_MqkcqhG2w2dk,870
@@ -163,8 +163,8 @@ tests/test_rtn_pypower.py,sha256=KO5VOZxETxVH2mY1mgNvzj1gz1Gdak1sAWxYleDU4E8,104
 tests/test_rtn_rted.py,sha256=QHDUymorCqQAJKFlDgTy40JyLTGDvNVNU3tjbjDl3-0,9850
 tests/test_rtn_uc.py,sha256=UbMeaam3dZwgq2LAJokGOl3LT5B3TWKMjCp4dRcLs40,8497
 tests/test_service.py,sha256=6IP6CAH2xHxGHZM4-R8LjZxVJ2L10LcGaPDyRIqKLmc,2438
-ltbams-1.0.10.dist-info/METADATA,sha256=607sw75UjOTCI4FuqQROlZn7BobwBeBubXQ5r9H_Bgc,13511
-ltbams-1.0.10.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-ltbams-1.0.10.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
-ltbams-1.0.10.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
-ltbams-1.0.10.dist-info/RECORD,,
+ltbams-1.0.11.dist-info/METADATA,sha256=HJopLlES434MQhl_hg4DDQNs90TfSJLovZKG-NChtNs,13808
+ltbams-1.0.11.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+ltbams-1.0.11.dist-info/entry_points.txt,sha256=FA56FlhO_yVNeEf810SrorVQb7_Xsmo3_EW-W-ijUfA,37
+ltbams-1.0.11.dist-info/top_level.txt,sha256=pyKDqG2kj13F9-BYd_wkruRdBSqLXw8Nwc-cmljqrxg,15
+ltbams-1.0.11.dist-info/RECORD,,

tests/test_1st_system.py

@@ -30,7 +30,7 @@ class TestCodegen(unittest.TestCase):
             docum._var_doc(max_width=78, export=export)
             docum._service_doc(max_width=78, export=export)
             docum._param_doc(max_width=78, export=export)
-            docum.config.doc(max_width=78, export=export)
+            docum.parent.config.doc(max_width=78, export=export)
 
 
 class TestParamCorrection(unittest.TestCase):