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

docs/source/groupdoc/Reserve.rst

@@ -1,135 +0,0 @@
-.. _Reserve:
-
-================================================================================
-Reserve
-================================================================================
-Common Parameters: u, name, idx, zone
-
-Available models:
-SFR_,
-SR_,
-NSR_,
-VSGR_
-
-.. _SFR:
-
---------------------------------------------------------------------------------
-SFR
---------------------------------------------------------------------------------
-Zonal secondary frequency reserve (SFR) model.
-
-Notes
------
-- ``Zone`` model is required for this model, and zone is defined by Param ``Bus.zone``.
-
-Parameters
-----------
-
-+-------+---------------+------------------------------+---------+--------+------------+
-| Name  |    Symbol     |         Description          | Default |  Unit  | Properties |
-+=======+===============+==============================+=========+========+============+
-|  idx  |               | unique device idx            |         |        |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-|  u    | :math:`u`     | connection status            | 1       | *bool* |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-|  name |               | device name                  |         |        |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-|  zone |               | Zone code                    |         |        |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-|  du   | :math:`d_{u}` | Zonal RegUp reserve demand   | 0       |        |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-|  dd   | :math:`d_{d}` | Zonal RegDown reserve demand | 0       |        |            |
-+-------+---------------+------------------------------+---------+--------+------------+
-
-
-.. _SR:
-
---------------------------------------------------------------------------------
-SR
---------------------------------------------------------------------------------
-Zonal spinning reserve (SR) model.
-
-Notes
------
-- ``Zone`` model is required for this model, and zone is defined by Param ``Bus.zone``.
-- ``demand`` is multiplied to online unused generation capacity.
-
-Parameters
-----------
-
-+---------+----------------+-------------------------------+---------+--------+------------+
-|  Name   |     Symbol     |          Description          | Default |  Unit  | Properties |
-+=========+================+===============================+=========+========+============+
-|  idx    |                | unique device idx             |         |        |            |
-+---------+----------------+-------------------------------+---------+--------+------------+
-|  u      | :math:`u`      | connection status             | 1       | *bool* |            |
-+---------+----------------+-------------------------------+---------+--------+------------+
-|  name   |                | device name                   |         |        |            |
-+---------+----------------+-------------------------------+---------+--------+------------+
-|  zone   |                | Zone code                     |         |        |            |
-+---------+----------------+-------------------------------+---------+--------+------------+
-|  demand | :math:`d_{SR}` | Zonal spinning reserve demand | 0.100   |        |            |
-+---------+----------------+-------------------------------+---------+--------+------------+
-
-
-.. _NSR:
-
---------------------------------------------------------------------------------
-NSR
---------------------------------------------------------------------------------
-Zonal non-spinning reserve (NSR) model.
-
-Notes
------
-- ``Zone`` model is required for this model, and zone is defined by Param ``Bus.zone``.
-- ``demand`` is multiplied to offline generation capacity.
-
-Parameters
-----------
-
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-|  Name   |     Symbol      |            Description            | Default |  Unit  | Properties |
-+=========+=================+===================================+=========+========+============+
-|  idx    |                 | unique device idx                 |         |        |            |
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-|  u      | :math:`u`       | connection status                 | 1       | *bool* |            |
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-|  name   |                 | device name                       |         |        |            |
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-|  zone   |                 | Zone code                         |         |        |            |
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-|  demand | :math:`d_{NSR}` | Zonal non-spinning reserve demand | 0.100   |        |            |
-+---------+-----------------+-----------------------------------+---------+--------+------------+
-
-
-.. _VSGR:
-
---------------------------------------------------------------------------------
-VSGR
---------------------------------------------------------------------------------
-Zonal VSG provided reserve model.
-
-Notes
------
-- ``Zone`` model is required for this model, and zone is defined by Param ``Bus.zone``.
-
-Parameters
-----------
-
-+-------+----------------+------------------------------+---------+--------+------------+
-| Name  |     Symbol     |         Description          | Default |  Unit  | Properties |
-+=======+================+==============================+=========+========+============+
-|  idx  |                | unique device idx            |         |        |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-|  u    | :math:`u`      | connection status            | 1       | *bool* |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-|  name |                | device name                  |         |        |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-|  zone |                | Zone code                    |         |        |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-|  dvm  | :math:`d_{VM}` | Zonal virtual inertia demand | 0       | *s*    |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-|  dvd  | :math:`d_{VD}` | Zonal virtual damping demand | 0       | *p.u.* |            |
-+-------+----------------+------------------------------+---------+--------+------------+
-
-

docs/source/groupdoc/StaticGen.rst

@@ -1,229 +0,0 @@
-.. _StaticGen:
-
-================================================================================
-StaticGen
-================================================================================
-Generator group.
-
-Notes
------
-For co-simulation with ANDES, check
-`ANDES StaticGen <https://docs.andes.app/en/latest/groupdoc/StaticGen.html#staticgen>`_
-for replacing static generators with dynamic generators.
-
-Common Parameters: u, name, idx, bus, Sn, Vn, p0, q0, ra, xs, subidx, pmax, pmin, pg0, ctrl, R10, td1, td2, zone
-
-Common Variables: p, q
-
-Available models:
-Slack_,
-PV_
-
-.. _Slack:
-
---------------------------------------------------------------------------------
-Slack
---------------------------------------------------------------------------------
-Slack generator model.
-
-Parameters
-----------
-
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Name   |      Symbol       |                             Description                              | Default |   Unit   | Properties |
-+=========+===================+======================================================================+=========+==========+============+
-|  idx    |                   | unique device idx                                                    |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  u      | :math:`u`         | connection status                                                    | 1       | *bool*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  name   |                   | device name                                                          |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Sn     | :math:`S_n`       | Power rating                                                         | 100     |          | non_zero   |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Vn     | :math:`V_n`       | AC voltage rating                                                    | 110     |          | non_zero   |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  subidx |                   | index for generators on the same bus                                 |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  bus    |                   | idx of the installed bus                                             |         |          | mandatory  |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  busr   |                   | bus idx for remote voltage control                                   |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  p0     | :math:`p_0`       | active power set point in system base                                | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  q0     | :math:`q_0`       | reactive power set point in system base                              | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pmax   | :math:`p_{max}`   | maximum active power in system base                                  | 999     | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pmin   | :math:`p_{min}`   | minimum active power in system base                                  | -1      | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  qmax   | :math:`q_{max}`   | maximim reactive power in system base                                | 999     | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  qmin   | :math:`q_{min}`   | minimum reactive power in system base                                | -999    | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  v0     | :math:`v_0`       | voltage set point                                                    | 1       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  vmax   | :math:`v_{max}`   | maximum voltage voltage                                              | 1.400   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  vmin   | :math:`v_{min}`   | minimum allowed voltage                                              | 0.600   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  ra     | :math:`r_a`       | armature resistance                                                  | 0       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  xs     | :math:`x_s`       | armature reactance                                                   | 0.300   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  wmod   | :math:`w_{mod}`   | Machine ctrl. mode [PSS/E]                                           | 0       | *int*    |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  a0     | :math:`\theta_0`  | reference angle set point                                            | 0       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  ctrl   | :math:`c_{trl}`   | generator controllability                                            | 1       | *bool*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  uf     | :math:`u_{f}`     | enforced on/off status; 0 unenforced, 1 enforced on, -1 enforced off | 0       | *int*    |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Pc1    | :math:`P_{c1}`    | lower real power output of PQ capability curve                       | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Pc2    | :math:`P_{c2}`    | upper real power output of PQ capability curve                       | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc1min | :math:`Q_{c1min}` | minimum reactive power output at Pc1                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc1max | :math:`Q_{c1max}` | maximum reactive power output at Pc1                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc2min | :math:`Q_{c2min}` | minimum reactive power output at Pc2                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc2max | :math:`Q_{c2max}` | maximum reactive power output at Pc2                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Ragc   | :math:`R_{agc}`   | ramp rate for load following/AGC                                     | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  R10    | :math:`R_{10}`    | ramp rate for 10 minute reserves                                     | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  R30    | :math:`R_{30}`    | 30 minute ramp rate                                                  | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Rq     | :math:`R_{q}`     | ramp rate for reactive power (2 sec timescale)                       | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  apf    | :math:`a_{pf}`    | area participation factor                                            | 0       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pg0    | :math:`p_{g0}`    | active power start point (system base)                               | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  td1    | :math:`t_{d1}`    | minimum ON duration                                                  | 1       | *h*      |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  td2    | :math:`t_{d2}`    | minimum OFF duration                                                 | 0.500   | *h*      |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  zone   |                   | Retrieved zone idx                                                   |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-
-Variables
----------
-
-+------+-------------+-------+---------------------------+--------+
-| Name |   Symbol    | Type  |        Description        |  Unit  |
-+======+=============+=======+===========================+========+
-|  ud  | :math:`u_d` | Algeb | commitment decision       | *bool* |
-+------+-------------+-------+---------------------------+--------+
-|  p   | :math:`p`   | Algeb | active power generation   | *p.u.* |
-+------+-------------+-------+---------------------------+--------+
-|  q   | :math:`q`   | Algeb | reactive power generation | *p.u.* |
-+------+-------------+-------+---------------------------+--------+
-
-
-.. _PV:
-
---------------------------------------------------------------------------------
-PV
---------------------------------------------------------------------------------
-PV generator model.
-
-TODO: implement type conversion in config
-
-Parameters
-----------
-
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Name   |      Symbol       |                             Description                              | Default |   Unit   | Properties |
-+=========+===================+======================================================================+=========+==========+============+
-|  idx    |                   | unique device idx                                                    |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  u      | :math:`u`         | connection status                                                    | 1       | *bool*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  name   |                   | device name                                                          |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Sn     | :math:`S_n`       | Power rating                                                         | 100     |          | non_zero   |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Vn     | :math:`V_n`       | AC voltage rating                                                    | 110     |          | non_zero   |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  subidx |                   | index for generators on the same bus                                 |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  bus    |                   | idx of the installed bus                                             |         |          | mandatory  |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  busr   |                   | bus idx for remote voltage control                                   |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  p0     | :math:`p_0`       | active power set point in system base                                | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  q0     | :math:`q_0`       | reactive power set point in system base                              | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pmax   | :math:`p_{max}`   | maximum active power in system base                                  | 999     | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pmin   | :math:`p_{min}`   | minimum active power in system base                                  | -1      | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  qmax   | :math:`q_{max}`   | maximim reactive power in system base                                | 999     | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  qmin   | :math:`q_{min}`   | minimum reactive power in system base                                | -999    | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  v0     | :math:`v_0`       | voltage set point                                                    | 1       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  vmax   | :math:`v_{max}`   | maximum voltage voltage                                              | 1.400   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  vmin   | :math:`v_{min}`   | minimum allowed voltage                                              | 0.600   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  ra     | :math:`r_a`       | armature resistance                                                  | 0       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  xs     | :math:`x_s`       | armature reactance                                                   | 0.300   |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  wmod   | :math:`w_{mod}`   | Machine ctrl. mode [PSS/E]                                           | 0       | *int*    |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  ctrl   | :math:`c_{trl}`   | generator controllability                                            | 1       | *bool*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  uf     | :math:`u_{f}`     | enforced on/off status; 0 unenforced, 1 enforced on, -1 enforced off | 0       | *int*    |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Pc1    | :math:`P_{c1}`    | lower real power output of PQ capability curve                       | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Pc2    | :math:`P_{c2}`    | upper real power output of PQ capability curve                       | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc1min | :math:`Q_{c1min}` | minimum reactive power output at Pc1                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc1max | :math:`Q_{c1max}` | maximum reactive power output at Pc1                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc2min | :math:`Q_{c2min}` | minimum reactive power output at Pc2                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Qc2max | :math:`Q_{c2max}` | maximum reactive power output at Pc2                                 | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Ragc   | :math:`R_{agc}`   | ramp rate for load following/AGC                                     | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  R10    | :math:`R_{10}`    | ramp rate for 10 minute reserves                                     | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  R30    | :math:`R_{30}`    | 30 minute ramp rate                                                  | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  Rq     | :math:`R_{q}`     | ramp rate for reactive power (2 sec timescale)                       | 999     | *p.u./h* |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  apf    | :math:`a_{pf}`    | area participation factor                                            | 0       |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  pg0    | :math:`p_{g0}`    | active power start point (system base)                               | 0       | *p.u.*   |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  td1    | :math:`t_{d1}`    | minimum ON duration                                                  | 1       | *h*      |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  td2    | :math:`t_{d2}`    | minimum OFF duration                                                 | 0.500   | *h*      |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-|  zone   |                   | Retrieved zone idx                                                   |         |          |            |
-+---------+-------------------+----------------------------------------------------------------------+---------+----------+------------+
-
-Variables
----------
-
-+------+-------------+-------+---------------------------+--------+
-| Name |   Symbol    | Type  |        Description        |  Unit  |
-+======+=============+=======+===========================+========+
-|  ud  | :math:`u_d` | Algeb | commitment decision       | *bool* |
-+------+-------------+-------+---------------------------+--------+
-|  p   | :math:`p`   | Algeb | active power generation   | *p.u.* |
-+------+-------------+-------+---------------------------+--------+
-|  q   | :math:`q`   | Algeb | reactive power generation | *p.u.* |
-+------+-------------+-------+---------------------------+--------+
-
-

docs/source/groupdoc/StaticLoad.rst

@@ -1,53 +0,0 @@
-.. _StaticLoad:
-
-================================================================================
-StaticLoad
-================================================================================
-Static load group.
-
-Common Parameters: u, name, idx, bus, p0, q0, ctrl, zone
-
-Available models:
-PQ_
-
-.. _PQ:
-
---------------------------------------------------------------------------------
-PQ
---------------------------------------------------------------------------------
-PQ load model.
-
-TODO: implement type conversion in config
-
-Parameters
-----------
-
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  Name  |     Symbol      |                Description                | Default |  Unit  | Properties |
-+========+=================+===========================================+=========+========+============+
-|  idx   |                 | unique device idx                         |         |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  u     | :math:`u`       | connection status                         | 1       | *bool* |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  name  |                 | device name                               |         |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  bus   |                 | linked bus idx                            |         |        | mandatory  |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  Vn    | :math:`V_n`     | AC voltage rating                         | 110     | *kV*   | non_zero   |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  p0    | :math:`p_0`     | active power load in system base          | 0       | *p.u.* |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  q0    | :math:`q_0`     | reactive power load in system base        | 0       | *p.u.* |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  vmax  | :math:`v_{max}` | max voltage before switching to impedance | 1.200   |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  vmin  | :math:`v_{min}` | min voltage before switching to impedance | 0.800   |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  owner |                 | owner idx                                 |         |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  zone  |                 | Retrieved zone idx                        |         |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-|  ctrl  | :math:`c_{trl}` | load controllability                      | 1       |        |            |
-+--------+-----------------+-------------------------------------------+---------+--------+------------+
-
-

docs/source/groupdoc/StaticShunt.rst

@@ -1,45 +0,0 @@
-.. _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

@@ -1,63 +0,0 @@
-.. _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)* |            |
-+-------+-----------------+-------------------------------+---------+--------------+------------+
-
-