-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# documentation |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 8877e6347a06d7715fbcd4c727097442 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# documentation |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line is installed correctly use ``dragonfly-energy --help`` | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
translate | ||
install | ||
simulate |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
install | ||
======= | ||
|
||
.. click:: dragonfly_energy.cli.install:install | ||
:prog: dragonfly-energy install | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
simulate | ||
======== | ||
|
||
.. click:: dragonfly_energy.cli.simulate:simulate | ||
:prog: dragonfly-energy simulate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
translate | ||
========= | ||
|
||
.. click:: dragonfly_energy.cli.translate:translate | ||
:prog: dragonfly-energy translate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.cli.install module | ||
==================================== | ||
|
||
.. automodule:: dragonfly_energy.cli.install | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
dragonfly\_energy.cli package | ||
============================= | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.cli.install | ||
dragonfly_energy.cli.simulate | ||
dragonfly_energy.cli.translate | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: dragonfly_energy.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.cli.simulate module | ||
===================================== | ||
|
||
.. automodule:: dragonfly_energy.cli.simulate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.cli.translate module | ||
====================================== | ||
|
||
.. automodule:: dragonfly_energy.cli.translate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.config module | ||
=============================== | ||
|
||
.. automodule:: dragonfly_energy.config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.des.connector module | ||
====================================== | ||
|
||
.. automodule:: dragonfly_energy.des.connector | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.des.ghe module | ||
================================ | ||
|
||
.. automodule:: dragonfly_energy.des.ghe | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.des.junction module | ||
===================================== | ||
|
||
.. automodule:: dragonfly_energy.des.junction | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.des.loop module | ||
================================= | ||
|
||
.. automodule:: dragonfly_energy.des.loop | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
dragonfly\_energy.des package | ||
============================= | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.des.connector | ||
dragonfly_energy.des.ghe | ||
dragonfly_energy.des.junction | ||
dragonfly_energy.des.loop | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: dragonfly_energy.des | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.measure module | ||
================================ | ||
|
||
.. automodule:: dragonfly_energy.measure | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.colorobj module | ||
========================================= | ||
|
||
.. automodule:: dragonfly_energy.opendss.colorobj | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.connector module | ||
========================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.connector | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.junction module | ||
========================================= | ||
|
||
.. automodule:: dragonfly_energy.opendss.junction | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.lib.powerlines module | ||
=============================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.lib.powerlines | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
dragonfly\_energy.opendss.lib package | ||
===================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.opendss.lib.powerlines | ||
dragonfly_energy.opendss.lib.transformers | ||
dragonfly_energy.opendss.lib.wires | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: dragonfly_energy.opendss.lib | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.lib.transformers module | ||
================================================= | ||
|
||
.. automodule:: dragonfly_energy.opendss.lib.transformers | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.lib.wires module | ||
========================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.lib.wires | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.network module | ||
======================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.network | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.powerline module | ||
========================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.powerline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.result module | ||
======================================= | ||
|
||
.. automodule:: dragonfly_energy.opendss.result | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.road module | ||
===================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.road | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
dragonfly\_energy.opendss package | ||
================================= | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.opendss.lib | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.opendss.colorobj | ||
dragonfly_energy.opendss.connector | ||
dragonfly_energy.opendss.junction | ||
dragonfly_energy.opendss.network | ||
dragonfly_energy.opendss.powerline | ||
dragonfly_energy.opendss.result | ||
dragonfly_energy.opendss.road | ||
dragonfly_energy.opendss.substation | ||
dragonfly_energy.opendss.transformer | ||
dragonfly_energy.opendss.transformerprop | ||
dragonfly_energy.opendss.wire | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: dragonfly_energy.opendss | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.substation module | ||
=========================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.substation | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.transformer module | ||
============================================ | ||
|
||
.. automodule:: dragonfly_energy.opendss.transformer | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.transformerprop module | ||
================================================ | ||
|
||
.. automodule:: dragonfly_energy.opendss.transformerprop | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.opendss.wire module | ||
===================================== | ||
|
||
.. automodule:: dragonfly_energy.opendss.wire | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.properties.building module | ||
============================================ | ||
|
||
.. automodule:: dragonfly_energy.properties.building | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.properties.context module | ||
=========================================== | ||
|
||
.. automodule:: dragonfly_energy.properties.context | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.properties.model module | ||
========================================= | ||
|
||
.. automodule:: dragonfly_energy.properties.model | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.properties.room2d module | ||
========================================== | ||
|
||
.. automodule:: dragonfly_energy.properties.room2d | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
dragonfly\_energy.properties package | ||
==================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
dragonfly_energy.properties.building | ||
dragonfly_energy.properties.context | ||
dragonfly_energy.properties.model | ||
dragonfly_energy.properties.room2d | ||
dragonfly_energy.properties.story | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: dragonfly_energy.properties | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
dragonfly\_energy.properties.story module | ||
========================================= | ||
|
||
.. automodule:: dragonfly_energy.properties.story | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |