Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Dec 12, 2024
0 parents commit e76ca38
Show file tree
Hide file tree
Showing 245 changed files with 126,877 additions and 0 deletions.
1 change: 1 addition & 0 deletions .nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
4 changes: 4 additions & 0 deletions docs/.buildinfo
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
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/install.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/simulate.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/translate.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.cli.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.config.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.des.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.des.ghe.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.des.loop.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.measure.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.opendss.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.reopt.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.run.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_energy.writer.doctree
Binary file not shown.
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/modules.doctree
Binary file not shown.
Empty file added docs/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
2,079 changes: 2,079 additions & 0 deletions docs/_modules/dragonfly_energy/cli/translate.html

Large diffs are not rendered by default.

1,417 changes: 1,417 additions & 0 deletions docs/_modules/dragonfly_energy/config.html

Large diffs are not rendered by default.

1,161 changes: 1,161 additions & 0 deletions docs/_modules/dragonfly_energy/des/connector.html

Large diffs are not rendered by default.

2,218 changes: 2,218 additions & 0 deletions docs/_modules/dragonfly_energy/des/ghe.html

Large diffs are not rendered by default.

1,095 changes: 1,095 additions & 0 deletions docs/_modules/dragonfly_energy/des/junction.html

Large diffs are not rendered by default.

2,335 changes: 2,335 additions & 0 deletions docs/_modules/dragonfly_energy/des/loop.html

Large diffs are not rendered by default.

1,188 changes: 1,188 additions & 0 deletions docs/_modules/dragonfly_energy/measure.html

Large diffs are not rendered by default.

1,310 changes: 1,310 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/colorobj.html

Large diffs are not rendered by default.

1,194 changes: 1,194 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/connector.html

Large diffs are not rendered by default.

1,093 changes: 1,093 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/junction.html

Large diffs are not rendered by default.

1,015 changes: 1,015 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/lib/powerlines.html

Large diffs are not rendered by default.

1,016 changes: 1,016 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/lib/transformers.html

Large diffs are not rendered by default.

1,010 changes: 1,010 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/lib/wires.html

Large diffs are not rendered by default.

1,828 changes: 1,828 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/network.html

Large diffs are not rendered by default.

1,372 changes: 1,372 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/powerline.html

Large diffs are not rendered by default.

1,121 changes: 1,121 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/result.html

Large diffs are not rendered by default.

1,093 changes: 1,093 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/road.html

Large diffs are not rendered by default.

1,111 changes: 1,111 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/substation.html

Large diffs are not rendered by default.

1,189 changes: 1,189 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/transformer.html

Large diffs are not rendered by default.

1,298 changes: 1,298 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/transformerprop.html

Large diffs are not rendered by default.

1,503 changes: 1,503 additions & 0 deletions docs/_modules/dragonfly_energy/opendss/wire.html

Large diffs are not rendered by default.

1,568 changes: 1,568 additions & 0 deletions docs/_modules/dragonfly_energy/properties/building.html

Large diffs are not rendered by default.

1,191 changes: 1,191 additions & 0 deletions docs/_modules/dragonfly_energy/properties/context.html

Large diffs are not rendered by default.

1,705 changes: 1,705 additions & 0 deletions docs/_modules/dragonfly_energy/properties/model.html

Large diffs are not rendered by default.

1,451 changes: 1,451 additions & 0 deletions docs/_modules/dragonfly_energy/properties/room2d.html

Large diffs are not rendered by default.

1,222 changes: 1,222 additions & 0 deletions docs/_modules/dragonfly_energy/properties/story.html

Large diffs are not rendered by default.

1,691 changes: 1,691 additions & 0 deletions docs/_modules/dragonfly_energy/reopt.html

Large diffs are not rendered by default.

2,361 changes: 2,361 additions & 0 deletions docs/_modules/dragonfly_energy/run.html

Large diffs are not rendered by default.

1,357 changes: 1,357 additions & 0 deletions docs/_modules/dragonfly_energy/writer.html

Large diffs are not rendered by default.

1,006 changes: 1,006 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions docs/_sources/cli/index.rst.txt
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
6 changes: 6 additions & 0 deletions docs/_sources/cli/install.rst.txt
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:
6 changes: 6 additions & 0 deletions docs/_sources/cli/simulate.rst.txt
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:
6 changes: 6 additions & 0 deletions docs/_sources/cli/translate.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.cli.install.rst.txt
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:
20 changes: 20 additions & 0 deletions docs/_sources/dragonfly_energy.cli.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.cli.simulate.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.cli.translate.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.config.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.des.connector.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.des.ghe.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.des.junction.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.des.loop.rst.txt
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:
21 changes: 21 additions & 0 deletions docs/_sources/dragonfly_energy.des.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.measure.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.colorobj.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.connector.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.junction.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.lib.powerlines.rst.txt
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:
20 changes: 20 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.lib.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.lib.wires.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.network.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.powerline.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.result.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.road.rst.txt
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:
36 changes: 36 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.substation.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.transformer.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.opendss.wire.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.properties.building.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.properties.context.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.properties.model.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.properties.room2d.rst.txt
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:
22 changes: 22 additions & 0 deletions docs/_sources/dragonfly_energy.properties.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_energy.properties.story.rst.txt
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:
Loading

0 comments on commit e76ca38

Please sign in to comment.