ltbams 0.9.9__py3-none-any.whl → 1.0.0__py3-none-any.whl

docs/source/groupdoc/StaticShunt.rst

@@ -0,0 +1,45 @@
+.. _StaticShunt:
+
+================================================================================
+StaticShunt
+================================================================================
+Static shunt compensator group.
+
+Common Parameters: u, name, idx
+
+Available models:
+Shunt_
+
+.. _Shunt:
+
+--------------------------------------------------------------------------------
+Shunt
+--------------------------------------------------------------------------------
+Phasor-domain shunt compensator Model.
+
+Parameters
+----------
+
++-------+-------------+--------------------------------------------+---------+--------+------------+
+| Name  |   Symbol    |                Description                 | Default |  Unit  | Properties |
++=======+=============+============================================+=========+========+============+
+|  idx  |             | unique device idx                          |         |        |            |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  u    | :math:`u`   | connection status                          | 1       | *bool* |            |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  name |             | device name                                |         |        |            |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  bus  |             | idx of connected bus                       |         |        | mandatory  |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  Sn   | :math:`S_n` | Power rating                               | 100     |        | non_zero   |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  Vn   | :math:`V_n` | AC voltage rating                          | 110     |        | non_zero   |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  g    | :math:`g`   | shunt conductance (real part)              | 0       |        | y          |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  b    | :math:`b`   | shunt susceptance (positive as capacitive) | 0       |        | y          |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+|  fn   | :math:`f_n` | rated frequency                            | 60      |        |            |
++-------+-------------+--------------------------------------------+---------+--------+------------+
+
+

docs/source/groupdoc/Undefined.rst

@@ -0,0 +1,63 @@
+.. _Undefined:
+
+================================================================================
+Undefined
+================================================================================
+The undefined group. Holds models with no ``group``.
+
+Common Parameters: u, name, idx
+
+Available models:
+SRCost_,
+NSRCost_
+
+.. _SRCost:
+
+--------------------------------------------------------------------------------
+SRCost
+--------------------------------------------------------------------------------
+Linear spinning reserve cost model.
+
+Parameters
+----------
+
++-------+----------------+---------------------------+---------+--------------+------------+
+| Name  |     Symbol     |        Description        | Default |     Unit     | Properties |
++=======+================+===========================+=========+==============+============+
+|  idx  |                | unique device idx         |         |              |            |
++-------+----------------+---------------------------+---------+--------------+------------+
+|  u    | :math:`u`      | connection status         | 1       | *bool*       |            |
++-------+----------------+---------------------------+---------+--------------+------------+
+|  name |                | device name               |         |              |            |
++-------+----------------+---------------------------+---------+--------------+------------+
+|  gen  |                | static generator index    |         |              | mandatory  |
++-------+----------------+---------------------------+---------+--------------+------------+
+|  csr  | :math:`c_{sr}` | cost for spinning reserve | 0       | *$/(p.u.*h)* |            |
++-------+----------------+---------------------------+---------+--------------+------------+
+
+
+.. _NSRCost:
+
+--------------------------------------------------------------------------------
+NSRCost
+--------------------------------------------------------------------------------
+Linear non-spinning reserve cost model.
+
+Parameters
+----------
+
++-------+-----------------+-------------------------------+---------+--------------+------------+
+| Name  |     Symbol      |          Description          | Default |     Unit     | Properties |
++=======+=================+===============================+=========+==============+============+
+|  idx  |                 | unique device idx             |         |              |            |
++-------+-----------------+-------------------------------+---------+--------------+------------+
+|  u    | :math:`u`       | connection status             | 1       | *bool*       |            |
++-------+-----------------+-------------------------------+---------+--------------+------------+
+|  name |                 | device name                   |         |              |            |
++-------+-----------------+-------------------------------+---------+--------------+------------+
+|  gen  |                 | static generator index        |         |              | mandatory  |
++-------+-----------------+-------------------------------+---------+--------------+------------+
+|  cnsr | :math:`c_{nsr}` | cost for non-spinning reserve | 0       | *$/(p.u.*h)* |            |
++-------+-----------------+-------------------------------+---------+--------------+------------+
+
+

docs/source/groupdoc/VSG.rst

@@ -0,0 +1,125 @@
+.. _VSG:
+
+================================================================================
+VSG
+================================================================================
+Renewable generator with virtual synchronous generator (VSG) control group.
+
+Note that this is a group separate from ``RenGen`` for VSG scheduling study.
+
+Common Parameters: u, name, idx, bus, gen, Sn
+
+Common Variables: Pe, Qe
+
+Available models:
+REGCV1_,
+REGCV2_
+
+.. _REGCV1:
+
+--------------------------------------------------------------------------------
+REGCV1
+--------------------------------------------------------------------------------
+Voltage-controlled converter model (virtual synchronous generator) with
+inertia emulation.
+
+Here Mmax and Dmax are assumed to be constant, but they might subject to
+the operating condition of the converter.
+
+Notes
+-----
+- The generation is defined by group :ref:`StaticGen`
+- Generation cost is defined by model :ref:`GCost`
+- Inertia emulation cost is defined by model :ref:`VSGCost`
+
+Reference:
+
+[1] ANDES Documentation, REGCV1
+
+Available:
+
+https://docs.andes.app/en/latest/groupdoc/RenGen.html#regcv1
+
+Parameters
+----------
+
++---------+------------------+------------------------------+---------+--------+------------+
+|  Name   |      Symbol      |         Description          | Default |  Unit  | Properties |
++=========+==================+==============================+=========+========+============+
+|  idx    |                  | unique device idx            |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  u      | :math:`u`        | connection status            | 1       | *bool* |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  name   |                  | device name                  |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  bus    |                  | interface bus idx            |         |        | mandatory  |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gen    |                  | static generator index       |         |        | mandatory  |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Sn     | :math:`S_n`      | device MVA rating            | 100     | *MVA*  |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gammap | :math:`\gamma_P` | P ratio of linked static gen | 1       |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gammaq | :math:`\gamma_Q` | Q ratio of linked static gen | 1       |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  zone   |                  | Retrieved zone idx           |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  M      | :math:`M`        | Inertia emulation            | 10      | *s*    | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  D      | :math:`D`        | Damping emulation            | 0       | *p.u.* | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Mmax   | :math:`M_{max}`  | Maximum inertia emulation    | 99      | *s*    | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Dmax   | :math:`D_{max}`  | Maximum damping emulation    | 99      | *p.u.* | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+
+
+.. _REGCV2:
+
+--------------------------------------------------------------------------------
+REGCV2
+--------------------------------------------------------------------------------
+Voltage-controlled VSC, identical to :ref:`REGCV1`.
+
+Reference:
+
+[1] ANDES Documentation, REGCV2
+
+Available:
+
+https://docs.andes.app/en/latest/groupdoc/RenGen.html#regcv2
+
+Parameters
+----------
+
++---------+------------------+------------------------------+---------+--------+------------+
+|  Name   |      Symbol      |         Description          | Default |  Unit  | Properties |
++=========+==================+==============================+=========+========+============+
+|  idx    |                  | unique device idx            |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  u      | :math:`u`        | connection status            | 1       | *bool* |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  name   |                  | device name                  |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  bus    |                  | interface bus idx            |         |        | mandatory  |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gen    |                  | static generator index       |         |        | mandatory  |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Sn     | :math:`S_n`      | device MVA rating            | 100     | *MVA*  |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gammap | :math:`\gamma_P` | P ratio of linked static gen | 1       |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  gammaq | :math:`\gamma_Q` | Q ratio of linked static gen | 1       |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  zone   |                  | Retrieved zone idx           |         |        |            |
++---------+------------------+------------------------------+---------+--------+------------+
+|  M      | :math:`M`        | Inertia emulation            | 10      | *s*    | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  D      | :math:`D`        | Damping emulation            | 0       | *p.u.* | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Mmax   | :math:`M_{max}`  | Maximum inertia emulation    | 99      | *s*    | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+|  Dmax   | :math:`D_{max}`  | Maximum damping emulation    | 99      | *p.u.* | power      |
++---------+------------------+------------------------------+---------+--------+------------+
+
+

docs/source/index.rst

@@ -0,0 +1,108 @@
+.. AMS documentation master file, created by
+   sphinx-quickstart on Thu Jan 26 15:32:32 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+==================
+AMS documentation
+==================
+**Useful Links**: `Source Repository`_ | `Report Issues`_ | `Q&A`_  | `LTB Repository`_
+| `ANDES Repository`_
+
+.. _`Source Repository`: https://github.com/CURENT/ams
+.. _`Report Issues`: https://github.com/CURENT/ams/issues
+.. _`Q&A`: https://github.com/CURENT/ams/discussions
+.. _`ANDES Repository`: https://github.com/CURENT/andes
+.. _`LTB Repository`: https://github.com/CURENT/
+
+LTB AMS is an open-source packages for scheduling modeling, serving as the market
+simulator for the CURENT Large scale Testbed (LTB).
+
+AMS enables **flexible** scheduling modeling and **interoprability** with the in-house
+dynamic simulator ANDES.
+
+.. panels::
+    :card: + intro-card text-center
+    :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex
+
+    ---
+
+    Getting started
+    ^^^^^^^^^^^^^^^
+
+    New to AMS? Check out the getting started guides.
+
+    +++
+
+    .. link-button:: getting-started
+            :type: ref
+            :text: To the getting started guides
+            :classes: btn-block btn-secondary stretched-link
+
+    ---
+
+    Examples
+    ^^^^^^^^
+
+    The examples of using AMS for power system scheduling study.
+
+    +++
+
+    .. link-button:: scripting_examples
+            :type: ref
+            :text: To the examples
+            :classes: btn-block btn-secondary stretched-link
+
+    ---
+
+    Model development guide
+    ^^^^^^^^^^^^^^^^^^^^^^^
+
+    New scheduling modeling in AMS.
+
+    +++
+
+    .. link-button:: development
+            :type: ref
+            :text: To the development guide
+            :classes: btn-block btn-secondary stretched-link
+    ---
+
+    API reference
+    ^^^^^^^^^^^^^
+
+    The API reference of AMS.
+
+    +++
+
+    .. link-button:: api_reference
+            :type: ref
+            :text: To the API reference
+            :classes: btn-block btn-secondary stretched-link
+
+    ---
+    :column: col-12 p-3
+
+    Using AMS for Research?
+    ^^^^^^^^^^^^^^^^^^^^^^^^^
+    Please cite our paper [Wang2025]_ if AMS is used in your research for
+    publication.
+
+
+.. [Wang2025] J. Wang et al., "Dynamics-incorporated Modeling Framework for Stability
+       Constrained Scheduling Under High-penetration of Renewable Energy," in IEEE
+       Transactions on Sustainable Energy, doi: 10.1109/TSTE.2025.3528027.
+
+
+.. toctree::
+   :maxdepth: 3
+   :caption: AMS Manual
+   :hidden:
+
+   getting_started/index
+   examples/index
+   modeling/index
+   release-notes
+   routineref
+   modelref
+   api

docs/source/modeling/_generated/_generated/ams.opt.Constraint.class_name.rst

@@ -0,0 +1,6 @@
+Constraint.class\_name
+======================
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.class_name

docs/source/modeling/_generated/_generated/ams.opt.Constraint.e.rst

@@ -0,0 +1,6 @@
+Constraint.e
+============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.e

docs/source/modeling/_generated/_generated/ams.opt.Constraint.evaluate.rst

@@ -0,0 +1,6 @@
+Constraint.evaluate
+===================
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Constraint.evaluate

docs/source/modeling/_generated/_generated/ams.opt.Constraint.n.rst

@@ -0,0 +1,6 @@
+Constraint.n
+============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.n

docs/source/modeling/_generated/_generated/ams.opt.Constraint.parse.rst

@@ -0,0 +1,6 @@
+Constraint.parse
+================
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Constraint.parse

docs/source/modeling/_generated/_generated/ams.opt.Constraint.shape.rst

@@ -0,0 +1,6 @@
+Constraint.shape
+================
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.shape

docs/source/modeling/_generated/_generated/ams.opt.Constraint.size.rst

@@ -0,0 +1,6 @@
+Constraint.size
+===============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.size

docs/source/modeling/_generated/_generated/ams.opt.Constraint.v.rst

@@ -0,0 +1,6 @@
+Constraint.v
+============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Constraint.v

docs/source/modeling/_generated/_generated/ams.opt.OModel.class_name.rst

@@ -0,0 +1,6 @@
+OModel.class\_name
+==================
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: OModel.class_name

docs/source/modeling/_generated/_generated/ams.opt.OModel.evaluate.rst

@@ -0,0 +1,6 @@
+OModel.evaluate
+===============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: OModel.evaluate

docs/source/modeling/_generated/_generated/ams.opt.OModel.finalize.rst

@@ -0,0 +1,6 @@
+OModel.finalize
+===============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: OModel.finalize

docs/source/modeling/_generated/_generated/ams.opt.OModel.init.rst

@@ -0,0 +1,6 @@
+OModel.init
+===========
+
+.. currentmodule:: ams.opt
+
+.. automethod:: OModel.init

docs/source/modeling/_generated/_generated/ams.opt.OModel.initialized.rst

@@ -0,0 +1,6 @@
+OModel.initialized
+==================
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: OModel.initialized

docs/source/modeling/_generated/_generated/ams.opt.OModel.parse.rst

@@ -0,0 +1,6 @@
+OModel.parse
+============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: OModel.parse

docs/source/modeling/_generated/_generated/ams.opt.OModel.update.rst

@@ -0,0 +1,6 @@
+OModel.update
+=============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: OModel.update

docs/source/modeling/_generated/_generated/ams.opt.Objective.class_name.rst

@@ -0,0 +1,6 @@
+Objective.class\_name
+=====================
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.class_name

docs/source/modeling/_generated/_generated/ams.opt.Objective.e.rst

@@ -0,0 +1,6 @@
+Objective.e
+===========
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.e

docs/source/modeling/_generated/_generated/ams.opt.Objective.evaluate.rst

@@ -0,0 +1,6 @@
+Objective.evaluate
+==================
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Objective.evaluate

docs/source/modeling/_generated/_generated/ams.opt.Objective.n.rst

@@ -0,0 +1,6 @@
+Objective.n
+===========
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.n

docs/source/modeling/_generated/_generated/ams.opt.Objective.parse.rst

@@ -0,0 +1,6 @@
+Objective.parse
+===============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Objective.parse

docs/source/modeling/_generated/_generated/ams.opt.Objective.shape.rst

@@ -0,0 +1,6 @@
+Objective.shape
+===============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.shape

docs/source/modeling/_generated/_generated/ams.opt.Objective.size.rst

@@ -0,0 +1,6 @@
+Objective.size
+==============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.size

docs/source/modeling/_generated/_generated/ams.opt.Objective.v.rst

@@ -0,0 +1,6 @@
+Objective.v
+===========
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Objective.v

docs/source/modeling/_generated/_generated/ams.opt.Var.class_name.rst

@@ -0,0 +1,6 @@
+Var.class\_name
+===============
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Var.class_name

docs/source/modeling/_generated/_generated/ams.opt.Var.evaluate.rst

@@ -0,0 +1,6 @@
+Var.evaluate
+============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Var.evaluate

docs/source/modeling/_generated/_generated/ams.opt.Var.get_idx.rst

@@ -0,0 +1,6 @@
+Var.get\_idx
+============
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Var.get_idx

docs/source/modeling/_generated/_generated/ams.opt.Var.n.rst

@@ -0,0 +1,6 @@
+Var.n
+=====
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Var.n

docs/source/modeling/_generated/_generated/ams.opt.Var.parse.rst

@@ -0,0 +1,6 @@
+Var.parse
+=========
+
+.. currentmodule:: ams.opt
+
+.. automethod:: Var.parse

docs/source/modeling/_generated/_generated/ams.opt.Var.shape.rst

@@ -0,0 +1,6 @@
+Var.shape
+=========
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Var.shape

docs/source/modeling/_generated/_generated/ams.opt.Var.size.rst

@@ -0,0 +1,6 @@
+Var.size
+========
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Var.size

docs/source/modeling/_generated/_generated/ams.opt.Var.v.rst

@@ -0,0 +1,6 @@
+Var.v
+=====
+
+.. currentmodule:: ams.opt
+
+.. autoproperty:: Var.v

docs/source/modeling/_generated/ams.opt.Constraint.rst

@@ -0,0 +1,43 @@
+ams.opt.Constraint
+==================
+
+.. currentmodule:: ams.opt
+
+.. autoclass:: Constraint
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated/
+
+   
+       
+       
+          ~Constraint.evaluate
+       
+       
+          ~Constraint.parse
+       
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated/
+
+   
+      ~Constraint.class_name
+      ~Constraint.e
+      ~Constraint.n
+      ~Constraint.shape
+      ~Constraint.size
+      ~Constraint.v
+   
+