Skip to content

Commit

Permalink
Add ref-manual documentation for net_model and form classes.
Browse files Browse the repository at this point in the history 
- mp.form
- mp.form_dc
- mp.form_ac
- mp.form_acc
- mp.form_acp
- mp.net_model_dc
- mp.net_model_ac
- mp.net_model_acc
- mp.net_model_acp
  • Loading branch information
@rdzman
rdzman committed Oct 11, 2023
1 parent 438813d commit 117b4a3
Show file tree
Hide file tree
Showing 29 changed files with 1,676 additions and 204 deletions.
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/form.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/form.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/form_ac.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/form_ac.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/form_acc.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/form_acc.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/form_acp.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/form_acp.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/form_dc.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/form_dc.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/net_model_ac.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/net_model_ac.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/net_model_acc.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/net_model_acc.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/net_model_acp.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/net_model_acp.m
1 change: 1 addition & 0 deletions docs/sphinx/source/matlab-source/matpower/+mp/net_model_dc.m
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../../../../lib/+mp/net_model_dc.m
9 changes: 9 additions & 0 deletions docs/sphinx/source/ref-manual/classes/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,16 @@ Network Model Classes

.. toctree::

mp/form
mp/form_dc
mp/form_ac
mp/form_acc
mp/form_acp
mp/net_model
mp/net_model_ac
mp/net_model_acc
mp/net_model_acp
mp/net_model_dc
mp/nm_element


Expand Down
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/form.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/form.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.form
-------

.. autoclass:: form
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/form_ac.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/form_ac.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.form_ac
----------

.. autoclass:: form_ac
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/form_acc.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/form_acc.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.form_acc
-----------

.. autoclass:: form_acc
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/form_acp.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/form_acp.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.form_acp
-----------

.. autoclass:: form_acp
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/form_dc.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/form_dc.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.form_dc
----------

.. autoclass:: form_dc
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/net_model_ac.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/net_model_ac.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.net_model_ac
---------------

.. autoclass:: net_model_ac
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/net_model_acc.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/net_model_acc.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.net_model_acc
----------------

.. autoclass:: net_model_acc
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/net_model_acp.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/net_model_acp.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.net_model_acp
----------------

.. autoclass:: net_model_acp
:show-inheritance:
:members:
10 changes: 10 additions & 0 deletions docs/sphinx/source/ref-manual/classes/mp/net_model_dc.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. automodule:: matpower.+mp

:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/+mp/net_model_dc.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`

mp.net_model_dc
---------------

.. autoclass:: net_model_dc
:show-inheritance:
:members:
Loading

0 comments on commit 117b4a3

Please sign in to comment.