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

docs/source/groupdoc/Collection.rst

@@ -1,84 +0,0 @@
-.. _Collection:
-
-================================================================================
-Collection
-================================================================================
-Collection of topology models
-
-Common Parameters: u, name, idx
-
-Available models:
-Area_,
-Zone_
-
-.. _Area:
-
---------------------------------------------------------------------------------
-Area
---------------------------------------------------------------------------------
-Area model.
-
-Parameters
-----------
-
-+-------+-----------+-------------------+---------+--------+------------+
-| Name  |  Symbol   |    Description    | Default |  Unit  | Properties |
-+=======+===========+===================+=========+========+============+
-|  idx  |           | unique device idx |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  u    | :math:`u` | connection status | 1       | *bool* |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  name |           | device name       |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-
-Services
-----------
-
-+-------------+-------------+--------------------+---------+
-|    Name     | Description |       Symbol       |  Type   |
-+=============+=============+====================+=========+
-|  Bus        |             | :math:`Bus`        | BackRef |
-+-------------+-------------+--------------------+---------+
-|  ACTopology |             | :math:`ACTopology` | BackRef |
-+-------------+-------------+--------------------+---------+
-
-
-.. _Zone:
-
---------------------------------------------------------------------------------
-Zone
---------------------------------------------------------------------------------
-Zone model for zonal items.
-
-An ``area`` can have multiple zones.
-
-Notes
------
-1. Zone is a collection of buses.
-2. Model ``Zone`` is not actually defined in ANDES.
-
-Parameters
-----------
-
-+-------+-----------+-------------------+---------+--------+------------+
-| Name  |  Symbol   |    Description    | Default |  Unit  | Properties |
-+=======+===========+===================+=========+========+============+
-|  idx  |           | unique device idx |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  u    | :math:`u` | connection status | 1       | *bool* |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  name |           | device name       |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-
-Services
-----------
-
-+-------------+-------------+--------------------+---------+
-|    Name     | Description |       Symbol       |  Type   |
-+=============+=============+====================+=========+
-|  Bus        |             | :math:`Bus`        | BackRef |
-+-------------+-------------+--------------------+---------+
-|  ACTopology |             | :math:`ACTopology` | BackRef |
-+-------------+-------------+--------------------+---------+
-
-

docs/source/groupdoc/Cost.rst

@@ -1,135 +0,0 @@
-.. _Cost:
-
-================================================================================
-Cost
-================================================================================
-Common Parameters: u, name, idx, gen
-
-Available models:
-GCost_,
-SFRCost_,
-VSGCost_,
-DCost_
-
-.. _GCost:
-
---------------------------------------------------------------------------------
-GCost
---------------------------------------------------------------------------------
-Generator cost model, similar to MATPOWER ``gencost`` format.
-
-``type`` is the cost model type. 1 for piecewise linear, 2 for polynomial.
-
-In piecewise linear cost model, cost function f(p) is defined by a set of points:
-(p0, c0), (p1, c1), (p2, c2), where p0 < p1 < p2.
-
-In quadratic cost model, cost function f(p) is defined by a set of coefficients:
-f(p) = c2 * p^2 + c1 * p + c0.
-
-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  |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  type | :math:`t_{ype}` | Cost model type. 1 for piecewise linear, 2 for polynomial | 2       |                |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  csu  | :math:`c_{su}`  | startup cost in US dollars                                | 0       | *$*            |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  csd  | :math:`c_{sd}`  | shutdown cost in US dollars                               | 0       | *$*            |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  c2   | :math:`c_{2}`   | coefficient 2                                             | 0       | *$/(p.u.*h)^2* |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  c1   | :math:`c_{1}`   | coefficient 1                                             | 0       | *$/p.u.*h*     |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-|  c0   | :math:`c_{0}`   | coefficient 0                                             | 0       | *$*            |            |
-+-------+-----------------+-----------------------------------------------------------+---------+----------------+------------+
-
-
-.. _SFRCost:
-
---------------------------------------------------------------------------------
-SFRCost
---------------------------------------------------------------------------------
-Linear SFR 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  |
-+-------+---------------+------------------------+---------+--------------+------------+
-|  cru  | :math:`c_{r}` | cost for RegUp reserve | 0       | *$/(p.u.*h)* |            |
-+-------+---------------+------------------------+---------+--------------+------------+
-|  crd  | :math:`c_{r}` | cost for RegDn reserve | 0       | *$/(p.u.*h)* |            |
-+-------+---------------+------------------------+---------+--------------+------------+
-
-
-.. _VSGCost:
-
---------------------------------------------------------------------------------
-VSGCost
---------------------------------------------------------------------------------
-Linear cost model for VSG emulated inertia (M) and damping (D).
-
-Parameters
-----------
-
-+-------+---------------+-------------------------------+---------+----------+------------+
-| Name  |    Symbol     |          Description          | Default |   Unit   | Properties |
-+=======+===============+===============================+=========+==========+============+
-|  idx  |               | unique device idx             |         |          |            |
-+-------+---------------+-------------------------------+---------+----------+------------+
-|  u    | :math:`u`     | connection status             | 1       | *bool*   |            |
-+-------+---------------+-------------------------------+---------+----------+------------+
-|  name |               | device name                   |         |          |            |
-+-------+---------------+-------------------------------+---------+----------+------------+
-|  reg  |               | Renewable generator idx       |         |          | mandatory  |
-+-------+---------------+-------------------------------+---------+----------+------------+
-|  cm   | :math:`c_{r}` | cost for emulated inertia (M) | 0       | *$/s*    |            |
-+-------+---------------+-------------------------------+---------+----------+------------+
-|  cd   | :math:`c_{r}` | cost for emulated damping (D) | 0       | *$/p.u.* |            |
-+-------+---------------+-------------------------------+---------+----------+------------+
-
-
-.. _DCost:
-
---------------------------------------------------------------------------------
-DCost
---------------------------------------------------------------------------------
-Linear cost model for dispatchable loads.
-
-Parameters
-----------
-
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-| Name  |     Symbol      |          Description          | Default |     Unit     | Properties |
-+=======+=================+===============================+=========+==============+============+
-|  idx  |                 | unique device idx             |         |              |            |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-|  u    | :math:`u`       | connection status             | 1       | *bool*       |            |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-|  name |                 | device name                   |         |              |            |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-|  pq   |                 | static load index             |         |              | mandatory  |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-|  cdp  | :math:`c_{d,p}` | cost for unserve load penalty | 999     | *$/(p.u.*h)* |            |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-
-

docs/source/groupdoc/DG.rst

@@ -1,204 +0,0 @@
-.. _DG:
-
-================================================================================
-DG
-================================================================================
-Distributed generation (small-scale).
-
-See ANDES Documentation SynGen here for the notes on replacing StaticGen and setting the power
-ratio parameters.
-
-Reference:
-
-[1] ANDES Documentation, SynGen, [Online]
-
-Available:
-
-https://docs.andes.app/en/latest/groupdoc/SynGen.html#syngen
-
-Common Parameters: u, name, idx, bus, fn
-
-Available models:
-PVD1_,
-ESD1_,
-EV1_,
-EV2_
-
-.. _PVD1:
-
---------------------------------------------------------------------------------
-PVD1
---------------------------------------------------------------------------------
-Distributed PV model, revised from ANDES ``PVD1`` model for
-scheduling.
-
-Following parameters are omitted from the original dynamic model:
-``fn``, ``busf``, ``xc``, ``pqflag``, ``igreg``, ``v0``, ``v1``,
-``dqdv``, ``fdbd``, ``ddn``, ``ialim``, ``vt0``, ``vt1``, ``vt2``,
-``vt3``, ``vrflag``, ``ft0``, ``ft1``, ``ft2``, ``ft3``, ``frflag``,
-``tip``, ``tiq``, ``recflag``.
-
-Reference:
-
-[1] ANDES Documentation, PVD1
-
-Available:
-
-https://docs.andes.app/en/latest/groupdoc/DG.html#pvd1
-
-Parameters
-----------
-
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  Name   |      Symbol      |                  Description                   | Default |  Unit  | Properties |
-+=========+==================+================================================+=========+========+============+
-|  idx    |                  | unique device idx                              |         |        |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  u      | :math:`u`        | connection status                              | 1       | *bool* |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  name   |                  | device name                                    |         |        |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  bus    |                  | interface bus id (place holder)                |         |        | mandatory  |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  gen    |                  | static generator index                         |         |        | mandatory  |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  Sn     | :math:`S_n`      | device MVA rating                              | 100     | *MVA*  |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  gammap | :math:`\gamma_p` | Ratio of ESD1.pref0 w.r.t to that of static PV | 1       |        |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-|  gammaq | :math:`\gamma_q` | Ratio of ESD1.qref0 w.r.t to that of static PV | 1       |        |            |
-+---------+------------------+------------------------------------------------+---------+--------+------------+
-
-
-.. _ESD1:
-
---------------------------------------------------------------------------------
-ESD1
---------------------------------------------------------------------------------
-Distributed energy storage model, revised from ANDES ``ESD1`` model for
-scheduling.
-
-Following parameters are omitted from the original dynamic model:
-``fn``, ``busf``, ``xc``, ``pqflag``, ``igreg``, ``v0``, ``v1``,
-``dqdv``, ``fdbd``, ``ddn``, ``ialim``, ``vt0``, ``vt1``, ``vt2``,
-``vt3``, ``vrflag``, ``ft0``, ``ft1``, ``ft2``, ``ft3``, ``frflag``,
-``tip``, ``tiq``, ``recflag``.
-
-Reference:
-
-[1] ANDES Documentation, ESD1
-
-Available:
-
-https://docs.andes.app/en/latest/groupdoc/DG.html#esd1
-
-Parameters
-----------
-
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|   Name   |       Symbol       |                  Description                   | Default |  Unit  | Properties |
-+==========+====================+================================================+=========+========+============+
-|  idx     |                    | unique device idx                              |         |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  u       | :math:`u`          | connection status                              | 1       | *bool* |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  name    |                    | device name                                    |         |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  bus     |                    | interface bus id (place holder)                |         |        | mandatory  |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  gen     |                    | static generator index                         |         |        | mandatory  |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  Sn      | :math:`S_n`        | device MVA rating                              | 100     | *MVA*  |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  gammap  | :math:`\gamma_p`   | Ratio of ESD1.pref0 w.r.t to that of static PV | 1       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  gammaq  | :math:`\gamma_q`   | Ratio of ESD1.qref0 w.r.t to that of static PV | 1       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  SOCmin  | :math:`SOC_{min}`  | Minimum required value for SOC in limiter      | 0       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  SOCmax  | :math:`SOC_{max}`  | Maximum allowed value for SOC in limiter       | 1       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  SOCinit | :math:`SOC_{init}` | Initial state of charge                        | 0.500   |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  En      | :math:`E_n`        | Rated energy capacity                          | 100     | *MWh*  |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  EtaC    | :math:`Eta_C`      | Efficiency during charging                     | 1       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-|  EtaD    | :math:`Eta_D`      | Efficiency during discharging                  | 1       |        |            |
-+----------+--------------------+------------------------------------------------+---------+--------+------------+
-
-
-.. _EV1:
-
---------------------------------------------------------------------------------
-EV1
---------------------------------------------------------------------------------
-Aggregated EV model for scheduling at transmission level.
-
-For co-simulation with ADNES, it is expected to be used in
-conjunction with the dynamic models `EV1` or `EV2`.
-
-Reference:
-
-[1] J. Wang et al., "Electric Vehicles Charging Time Constrained Deliverable Provision of Secondary
-Frequency Regulation," in IEEE Transactions on Smart Grid, doi: 10.1109/TSG.2024.3356948.
-
-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       |        |            |
-+---------+------------------+------------------------------+---------+--------+------------+
-|  N      | :math:`N`        | number of related EVs        | 10000   |        |            |
-+---------+------------------+------------------------------+---------+--------+------------+
-
-
-.. _EV2:
-
---------------------------------------------------------------------------------
-EV2
---------------------------------------------------------------------------------
-EV aggregation model at transmission level, identical to :ref:`EV1`.
-
-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       |        |            |
-+---------+------------------+------------------------------+---------+--------+------------+
-|  N      | :math:`N`        | number of related EVs        | 10000   |        |            |
-+---------+------------------+------------------------------+---------+--------+------------+
-
-

docs/source/groupdoc/Horizon.rst

@@ -1,97 +0,0 @@
-.. _Horizon:
-
-================================================================================
-Horizon
-================================================================================
-Time horizon group.
-
-Common Parameters: u, name, idx
-
-Available models:
-TimeSlot_,
-EDTSlot_,
-UCTSlot_
-
-.. _TimeSlot:
-
---------------------------------------------------------------------------------
-TimeSlot
---------------------------------------------------------------------------------
-Time slot data for rolling horizon.
-
-Parameters
-----------
-
-+-------+---------------+---------------------------+---------+--------+------------+
-| Name  |    Symbol     |        Description        | Default |  Unit  | Properties |
-+=======+===============+===========================+=========+========+============+
-|  idx  |               | unique device idx         |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  u    | :math:`u`     | connection status         | 1       | *bool* |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  name |               | device name               |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  sd   | :math:`s_{d}` | zonal load scaling factor |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-
-
-.. _EDTSlot:
-
---------------------------------------------------------------------------------
-EDTSlot
---------------------------------------------------------------------------------
-Time slot model for ED.
-
-`sd` is the zonal load scaling factor.
-Cells in `sd` should have `nz` values seperated by comma,
-where `nz` is the number of `Zone` in the system.
-
-`ug` is the unit commitment decisions.
-Cells in `ug` should have `ng` values seperated by comma,
-where `ng` is the number of `StaticGen` in the system.
-
-Parameters
-----------
-
-+-------+---------------+---------------------------+---------+--------+------------+
-| Name  |    Symbol     |        Description        | Default |  Unit  | Properties |
-+=======+===============+===========================+=========+========+============+
-|  idx  |               | unique device idx         |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  u    | :math:`u`     | connection status         | 1       | *bool* |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  name |               | device name               |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  sd   | :math:`s_{d}` | zonal load scaling factor |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  ug   | :math:`u_{g}` | unit commitment decisions |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-
-
-.. _UCTSlot:
-
---------------------------------------------------------------------------------
-UCTSlot
---------------------------------------------------------------------------------
-Time slot model for UC.
-
-`sd` is the zonal load scaling factor.
-Cells in `sd` should have `nz` values seperated by comma,
-where `nz` is the number of `Zone` in the system.
-
-Parameters
-----------
-
-+-------+---------------+---------------------------+---------+--------+------------+
-| Name  |    Symbol     |        Description        | Default |  Unit  | Properties |
-+=======+===============+===========================+=========+========+============+
-|  idx  |               | unique device idx         |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  u    | :math:`u`     | connection status         | 1       | *bool* |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  name |               | device name               |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-|  sd   | :math:`s_{d}` | zonal load scaling factor |         |        |            |
-+-------+---------------+---------------------------+---------+--------+------------+
-
-

docs/source/groupdoc/Information.rst

@@ -1,36 +0,0 @@
-.. _Information:
-
-================================================================================
-Information
-================================================================================
-Group for information container models.
-
-Available models:
-Summary_
-
-.. _Summary:
-
---------------------------------------------------------------------------------
-Summary
---------------------------------------------------------------------------------
-Class for storing system summary.
-Can be used for random information or notes.
-
-Parameters
-----------
-
-+-----------+--------+-----------------------------------+---------+------+------------+
-|   Name    | Symbol |            Description            | Default | Unit | Properties |
-+===========+========+===================================+=========+======+============+
-|  field    |        | field name                        |         |      |            |
-+-----------+--------+-----------------------------------+---------+------+------------+
-|  comment  |        | information, comment, or anything |         |      |            |
-+-----------+--------+-----------------------------------+---------+------+------------+
-|  comment2 |        | comment field 2                   |         |      |            |
-+-----------+--------+-----------------------------------+---------+------+------------+
-|  comment3 |        | comment field 3                   |         |      |            |
-+-----------+--------+-----------------------------------+---------+------+------------+
-|  comment4 |        | comment field 4                   |         |      |            |
-+-----------+--------+-----------------------------------+---------+------+------------+
-
-

docs/source/groupdoc/RenGen.rst

@@ -1,63 +0,0 @@
-.. _RenGen:
-
-================================================================================
-RenGen
-================================================================================
-Renewable generator (converter) group.
-
-See ANDES Documentation SynGen here for the notes on replacing StaticGen and setting the power
-ratio parameters.
-
-Reference:
-
-[1] ANDES Documentation, RenGen, [Online]
-
-Available:
-
-https://docs.andes.app/en/latest/groupdoc/RenGen.html#rengen
-
-Common Parameters: u, name, idx, bus, gen, Sn, q0
-
-Common Variables: Pe, Qe
-
-Available models:
-REGCA1_
-
-.. _REGCA1:
-
---------------------------------------------------------------------------------
-REGCA1
---------------------------------------------------------------------------------
-Renewable generator scheduling model.
-
-Reference:
-
-[1] ANDES Documentation, REGCA1
-
-Available:
-https://docs.andes.app/en/latest/groupdoc/RenGen.html#regca1
-
-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       |        |            |
-+---------+------------------+------------------------------+---------+--------+------------+
-
-