PyPI - ltbams - Versions diffs - 1.0.0__py3-none-any.whl → 1.0.2a1__py3-none-any.whl - Mend

ltbams 1.0.0py3-none-any.whl → 1.0.2a1py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (554) hide show

docs/source/groupdoc/VSG.rst DELETED Viewed

@@ -1,125 +0,0 @@
-.. _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/modeling/_generated/_generated/ams.opt.Constraint.class_name.rst DELETED Viewed

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,43 +0,0 @@
-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

docs/source/modeling/_generated/ams.opt.OModel.rst DELETED Viewed

@@ -1,48 +0,0 @@
-ams.opt.OModel
-==============
-.. currentmodule:: ams.opt
-.. autoclass:: OModel
-   .. automethod:: __init__
-   .. rubric:: Methods
-   .. autosummary::
-      :toctree: _generated/
-          ~OModel.evaluate
-          ~OModel.finalize
-          ~OModel.init
-          ~OModel.parse
-          ~OModel.update
-   .. rubric:: Attributes
-   .. autosummary::
-      :toctree: _generated/
-      ~OModel.class_name
-      ~OModel.initialized

docs/source/modeling/_generated/ams.opt.Objective.rst DELETED Viewed

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

docs/source/modeling/_generated/ams.opt.Var.rst DELETED Viewed

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

docs/source/modelref.rst DELETED Viewed

@@ -1,66 +0,0 @@
-.. _modelref:
-***************
-Model reference
-***************
-Use the left navigation pane to locate the group and model
-and view details.
-Supported Groups and Models
-+---------------------+------------------------------------------------------+
-|        Group        |                        Models                        |
-+=====================+======================================================+
-|  :ref:`ACLine`      | :ref:`Line`                                          |
-+---------------------+------------------------------------------------------+
-|  :ref:`ACShort`     | :ref:`Jumper`                                        |
-+---------------------+------------------------------------------------------+
-|  :ref:`ACTopology`  | :ref:`Bus`                                           |
-+---------------------+------------------------------------------------------+
-|  :ref:`Collection`  | :ref:`Area`, :ref:`Zone`                             |
-+---------------------+------------------------------------------------------+
-|  :ref:`Cost`        | :ref:`GCost`, :ref:`SFRCost`, :ref:`VSGCost`,        |
-|                     | :ref:`DCost`                                         |
-+---------------------+------------------------------------------------------+
-|  :ref:`DG`          | :ref:`PVD1`, :ref:`ESD1`, :ref:`EV1`, :ref:`EV2`     |
-+---------------------+------------------------------------------------------+
-|  :ref:`Horizon`     | :ref:`TimeSlot`, :ref:`EDTSlot`, :ref:`UCTSlot`      |
-+---------------------+------------------------------------------------------+
-|  :ref:`Information` | :ref:`Summary`                                       |
-+---------------------+------------------------------------------------------+
-|  :ref:`RenGen`      | :ref:`REGCA1`                                        |
-+---------------------+------------------------------------------------------+
-|  :ref:`Reserve`     | :ref:`SFR`, :ref:`SR`, :ref:`NSR`, :ref:`VSGR`       |
-+---------------------+------------------------------------------------------+
-|  :ref:`StaticGen`   | :ref:`Slack`, :ref:`PV`                              |
-+---------------------+------------------------------------------------------+
-|  :ref:`StaticLoad`  | :ref:`PQ`                                            |
-+---------------------+------------------------------------------------------+
-|  :ref:`StaticShunt` | :ref:`Shunt`                                         |
-+---------------------+------------------------------------------------------+
-|  :ref:`Undefined`   | :ref:`SRCost`, :ref:`NSRCost`                        |
-+---------------------+------------------------------------------------------+
-|  :ref:`VSG`         | :ref:`REGCV1`, :ref:`REGCV2`                         |
-+---------------------+------------------------------------------------------+
-.. toctree ::
-    :maxdepth: 2
-    :hidden:
-    groupdoc/ACLine
-    groupdoc/ACShort
-    groupdoc/ACTopology
-    groupdoc/Collection
-    groupdoc/Cost
-    groupdoc/DG
-    groupdoc/Horizon
-    groupdoc/Information
-    groupdoc/RenGen
-    groupdoc/Reserve
-    groupdoc/StaticGen
-    groupdoc/StaticLoad
-    groupdoc/StaticShunt
-    groupdoc/Undefined
-    groupdoc/VSG

docs/source/routineref.rst DELETED Viewed

@@ -1,38 +0,0 @@
-.. _routineref:
-*******************
-Routine reference
-*******************
-Use the left navigation pane to locate the group and model
-and view details.
-Supported Types and Routines
-+--------------+-------------------------------------------------------------+
-|     Type     |                          Routines                           |
-+==============+=============================================================+
-|  :ref:`ACED` | :ref:`ACOPF`                                                |
-+--------------+-------------------------------------------------------------+
-|  :ref:`DCED` | :ref:`DCOPF`, :ref:`ED`, :ref:`EDDG`, :ref:`EDES`,          |
-|              | :ref:`RTED`, :ref:`RTEDDG`, :ref:`RTEDES`, :ref:`RTEDVIS`   |
-+--------------+-------------------------------------------------------------+
-|  :ref:`DCUC` | :ref:`UC`, :ref:`UCDG`, :ref:`UCES`                         |
-+--------------+-------------------------------------------------------------+
-|  :ref:`DED`  | :ref:`DOPF`, :ref:`DOPFVIS`                                 |
-+--------------+-------------------------------------------------------------+
-|  :ref:`PF`   | :ref:`DCPF`, :ref:`PFlow`, :ref:`CPF`, :ref:`PFlow0`,       |
-|              | :ref:`DCPF0`                                                |
-+--------------+-------------------------------------------------------------+
-.. toctree ::
-    :maxdepth: 2
-    :hidden:
-    typedoc/ACED
-    typedoc/DCED
-    typedoc/DCUC
-    typedoc/DED
-    typedoc/PF
-    typedoc/UndefinedType

ltbams 1.0.0__py3-none-any.whl → 1.0.2a1__py3-none-any.whl

ltbams 1.0.0py3-none-any.whl → 1.0.2a1py3-none-any.whl