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/_generated/ams.system.System.rst DELETED Viewed

@@ -1,189 +0,0 @@
-ams.system.System
-=================
-.. currentmodule:: ams.system
-.. autoclass:: System
-   .. automethod:: __init__
-   .. rubric:: Methods
-   .. autosummary::
-      :toctree: _generated/
-          ~System.add
-          ~System.as_dict
-          ~System.calc_pu_coeff
-          ~System.call_models
-          ~System.collect_config
-          ~System.collect_ref
-          ~System.connectivity
-          ~System.e_clear
-          ~System.f_update
-          ~System.fg_to_dae
-          ~System.find_devices
-          ~System.find_models
-          ~System.from_ipysheet
-          ~System.g_islands
-          ~System.g_update
-          ~System.get_z
-          ~System.import_groups
-          ~System.import_models
-          ~System.import_routines
-          ~System.import_types
-          ~System.init
-          ~System.j_islands
-          ~System.j_update
-          ~System.l_update_eq
-          ~System.l_update_var
-          ~System.link_ext_param
-          ~System.precompile
-          ~System.prepare
-          ~System.reload
-          ~System.remove_pycapsule
-          ~System.report
-          ~System.reset
-          ~System.s_update_post
-          ~System.s_update_var
-          ~System.save_config
-          ~System.set_address
-          ~System.set_config
-          ~System.set_dae_names
-          ~System.set_output_subidx
-          ~System.set_var_arrays
-          ~System.setup
-          ~System.store_adder_setter
-          ~System.store_existing
-          ~System.store_no_check_init
-          ~System.store_sparse_pattern
-          ~System.store_switch_times
-          ~System.summary
-          ~System.supported_models
-          ~System.supported_routines
-          ~System.switch_action
-          ~System.to_andes
-          ~System.to_ipysheet
-          ~System.undill
-          ~System.vars_to_dae
-          ~System.vars_to_models

docs/source/_generated/ams.system.disable_method.rst DELETED Viewed

@@ -1,6 +0,0 @@
-disable\_method
-===============
-.. currentmodule:: ams.system
-.. autofunction:: disable_method

docs/source/_generated/ams.system.disable_methods.rst DELETED Viewed

@@ -1,6 +0,0 @@
-disable\_methods
-================
-.. currentmodule:: ams.system
-.. autofunction:: disable_methods

docs/source/_generated/ams.system.example.rst DELETED Viewed

@@ -1,6 +0,0 @@
-example
-=======
-.. currentmodule:: ams.system
-.. autofunction:: example

docs/source/_generated/ams.system.rst DELETED Viewed

@@ -1,39 +0,0 @@
-ams.system
-==========
-.. automodule:: ams.system
-   .. rubric:: Functions
-   .. autosummary::
-      :toctree:
-      disable_method
-      disable_methods
-      example
-   .. rubric:: Classes
-   .. autosummary::
-      :toctree:
-      System

docs/source/_generated/ams.utils.paths.DisplayablePath.rst DELETED Viewed

@@ -1,42 +0,0 @@
-ams.utils.paths.DisplayablePath
-===============================
-.. currentmodule:: ams.utils.paths
-.. autoclass:: DisplayablePath
-   .. automethod:: __init__
-   .. rubric:: Methods
-   .. autosummary::
-      :toctree: _generated/
-          ~DisplayablePath.displayable
-          ~DisplayablePath.make_tree
-   .. rubric:: Attributes
-   .. autosummary::
-      :toctree: _generated/
-      ~DisplayablePath.display_filename_prefix_last
-      ~DisplayablePath.display_filename_prefix_middle
-      ~DisplayablePath.display_parent_prefix_last
-      ~DisplayablePath.display_parent_prefix_middle
-      ~DisplayablePath.displayname

docs/source/_generated/ams.utils.paths.ams_root.rst DELETED Viewed

@@ -1,6 +0,0 @@
-ams\_root
-=========
-.. currentmodule:: ams.utils.paths
-.. autofunction:: ams_root

docs/source/_generated/ams.utils.paths.cases_root.rst DELETED Viewed

@@ -1,6 +0,0 @@
-cases\_root
-===========
-.. currentmodule:: ams.utils.paths
-.. autofunction:: cases_root

docs/source/_generated/ams.utils.paths.confirm_overwrite.rst DELETED Viewed

@@ -1,6 +0,0 @@
-confirm\_overwrite
-==================
-.. currentmodule:: ams.utils.paths
-.. autofunction:: confirm_overwrite

docs/source/_generated/ams.utils.paths.get_case.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_case
-=========
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_case

docs/source/_generated/ams.utils.paths.get_config_path.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_config\_path
-=================
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_config_path

docs/source/_generated/ams.utils.paths.get_dot_andes_path.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_dot\_andes\_path
-=====================
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_dot_andes_path

docs/source/_generated/ams.utils.paths.get_log_dir.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_log\_dir
-=============
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_log_dir

docs/source/_generated/ams.utils.paths.get_pkl_path.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_pkl\_path
-==============
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_pkl_path

docs/source/_generated/ams.utils.paths.get_pycode_path.rst DELETED Viewed

@@ -1,6 +0,0 @@
-get\_pycode\_path
-=================
-.. currentmodule:: ams.utils.paths
-.. autofunction:: get_pycode_path

docs/source/_generated/ams.utils.paths.list_cases.rst DELETED Viewed

@@ -1,6 +0,0 @@
-list\_cases
-===========
-.. currentmodule:: ams.utils.paths
-.. autofunction:: list_cases

docs/source/_generated/ams.utils.paths.rst DELETED Viewed

@@ -1,47 +0,0 @@
-ams.utils.paths
-===============
-.. automodule:: ams.utils.paths
-   .. rubric:: Functions
-   .. autosummary::
-      :toctree:
-      ams_root
-      cases_root
-      confirm_overwrite
-      get_case
-      get_config_path
-      get_dot_andes_path
-      get_log_dir
-      get_pkl_path
-      get_pycode_path
-      list_cases
-      tests_root
-   .. rubric:: Classes
-   .. autosummary::
-      :toctree:
-      DisplayablePath

docs/source/_generated/ams.utils.paths.tests_root.rst DELETED Viewed

@@ -1,6 +0,0 @@
-tests\_root
-===========
-.. currentmodule:: ams.utils.paths
-.. autofunction:: tests_root

docs/source/groupdoc/ACLine.rst DELETED Viewed

@@ -1,92 +0,0 @@
-.. _ACLine:
-================================================================================
-ACLine
-================================================================================
-Common Parameters: u, name, idx, bus1, bus2, r, x
-Available models:
-Line_
-.. _Line:
---------------------------------------------------------------------------------
-Line
---------------------------------------------------------------------------------
-AC transmission line model.
-The model is also used for two-winding transformer. Transformers can set the
-tap ratio in ``tap`` and/or phase shift angle ``phi``.
-Note that the bus admittance matrix is built on fly and is not stored in the
-object.
-Notes
------
-There is a known issue that adding Algeb ``ud`` will cause Line.algebs run into
-AttributeError: 'NoneType' object has no attribute 'n'. Not figured out why yet.
-Parameters
-----------
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  Name   |      Symbol      |                 Description                 | Default |   Unit   |  Properties  |
-+=========+==================+=============================================+=========+==========+==============+
-|  idx    |                  | unique device idx                           |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  u      | :math:`u`        | connection status                           | 1       | *bool*   |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  name   |                  | device name                                 |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  bus1   |                  | idx of from bus                             |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  bus2   |                  | idx of to bus                               |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  Sn     | :math:`S_n`      | Power rating                                | 100     | *MW*     | non_zero     |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  fn     | :math:`f`        | rated frequency                             | 60      | *Hz*     |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  Vn1    | :math:`V_{n1}`   | AC voltage rating                           | 110     | *kV*     | non_zero     |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  Vn2    | :math:`V_{n2}`   | rated voltage of bus2                       | 110     | *kV*     | non_zero     |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  r      | :math:`r`        | line resistance                             | 0.000   | *p.u.*   | z            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  x      | :math:`x`        | line reactance                              | 0.000   | *p.u.*   | non_zero,z   |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  b      |                  | shared shunt susceptance                    | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  g      |                  | shared shunt conductance                    | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  b1     | :math:`b_1`      | from-side susceptance                       | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  g1     | :math:`g_1`      | from-side conductance                       | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  b2     | :math:`b_2`      | to-side susceptance                         | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  g2     | :math:`g_2`      | to-side conductance                         | 0       | *p.u.*   | y            |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  trans  |                  | transformer branch flag                     | 0       | *bool*   |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  tap    | :math:`t_{ap}`   | transformer branch tap ratio                | 1       | *float*  | non_negative |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  phi    | :math:`\phi`     | transformer branch phase shift in rad       | 0       | *radian* |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  rate_a | :math:`R_{ATEA}` | long-term flow limit (placeholder)          | 999     | *p.u.*   |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  rate_b | :math:`R_{ATEB}` | short-term flow limit (placeholder)         | 999     | *p.u.*   |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  rate_c | :math:`R_{ATEC}` | emergency flow limit (placeholder)          | 999     | *p.u.*   |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  owner  |                  | owner code                                  |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  xcoord |                  | x coordinates                               |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  ycoord |                  | y coordinates                               |         |          |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  amin   | :math:`a_{min}`  | minimum angle difference, from bus - to bus | -6.283  | *rad*    |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+
-|  amax   | :math:`a_{max}`  | maximum angle difference, from bus - to bus | 6.283   | *rad*    |              |
-+---------+------------------+---------------------------------------------+---------+----------+--------------+

docs/source/groupdoc/ACShort.rst DELETED Viewed

@@ -1,51 +0,0 @@
-.. _ACShort:
-================================================================================
-ACShort
-================================================================================
-Common Parameters: u, name, idx, bus1, bus2
-Available models:
-Jumper_
-.. _Jumper:
---------------------------------------------------------------------------------
-Jumper
---------------------------------------------------------------------------------
-Jumper is a device to short two buses (merging two buses into one).
-Jumper can connect two buses satisfying one of the following conditions:
-- neither bus is voltage-controlled
-- either bus is voltage-controlled
-- both buses are voltage-controlled, and the voltages are the same.
-If the buses are controlled in different voltages, power flow will
-not solve (as the power flow through the jumper will be infinite).
-In the solutions, the ``p`` and ``q`` are flowing out of bus1
-and flowing into bus2.
-Setting a Jumper's connectivity status ``u`` to zero will disconnect the two
-buses. In the case of a system split, one will need to call
-``System.connectivity()`` immediately following the split to detect islands.
-Parameters
-----------
-+-------+-----------+-------------------+---------+--------+------------+
-| Name  |  Symbol   |    Description    | Default |  Unit  | Properties |
-+=======+===========+===================+=========+========+============+
-|  idx  |           | unique device idx |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  u    | :math:`u` | connection status | 1       | *bool* |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  name |           | device name       |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  bus1 |           | idx of from bus   |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+
-|  bus2 |           | idx of to bus     |         |        |            |
-+-------+-----------+-------------------+---------+--------+------------+

docs/source/groupdoc/ACTopology.rst DELETED Viewed

@@ -1,66 +0,0 @@
-.. _ACTopology:
-================================================================================
-ACTopology
-================================================================================
-Common Parameters: u, name, idx
-Common Variables: a, v
-Available models:
-Bus_
-.. _Bus:
---------------------------------------------------------------------------------
-Bus
---------------------------------------------------------------------------------
-AC Bus model.
-Parameters
-----------
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  Name   |      Symbol      |                      Description                       | Default |  Unit  | Properties |
-+=========+==================+========================================================+=========+========+============+
-|  idx    |                  | unique device idx                                      |         |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  u      | :math:`u`        | connection status                                      | 1       | *bool* |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  name   |                  | device name                                            |         |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  Vn     | :math:`V_n`      | AC voltage rating                                      | 110     | *kV*   | non_zero   |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  vmax   | :math:`V_{max}`  | Voltage upper limit                                    | 1.100   | *p.u.* |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  vmin   | :math:`V_{min}`  | Voltage lower limit                                    | 0.900   | *p.u.* |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  v0     | :math:`V_0`      | initial voltage magnitude                              | 1       | *p.u.* | non_zero   |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  a0     | :math:`\theta_0` | initial voltage phase angle                            | 0       | *rad*  |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  xcoord |                  | x coordinate (longitude)                               | 0       |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  ycoord |                  | y coordinate (latitude)                                | 0       |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  area   |                  | Area code                                              |         |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  zone   |                  | Zone code                                              |         |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  owner  |                  | Owner code                                             |         |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-|  type   | :math:`type`     | bus type, 1=PQ, 2=PV, 3=ref, 4=isolated (place holder) | 1       |        |            |
-+---------+------------------+--------------------------------------------------------+---------+--------+------------+
-Variables
----------
-+------+----------------+-------+-------------------+--------+
-| Name |     Symbol     | Type  |    Description    |  Unit  |
-+======+================+=======+===================+========+
-|  a   | :math:`\theta` | Algeb | voltage angle     | *rad*  |
-+------+----------------+-------+-------------------+--------+
-|  v   | :math:`V`      | Algeb | voltage magnitude | *p.u.* |
-+------+----------------+-------+-------------------+--------+

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