Skip to content

Commit

Permalink
fixed issue #302
Browse files Browse the repository at this point in the history
Problem: no documentation for multiprocessing runs
Solution: added documentation for multiprocessing runs in ./docs/runningeplus.ipynb
    modified:   docs/eppy.rst
    modified:   docs/runningeplus.ipynb
  • Loading branch information
santoshphilip committed Oct 25, 2020
1 parent 9658fad commit cc649e4
Show file tree
Hide file tree
Showing 2 changed files with 240 additions and 89 deletions.
154 changes: 79 additions & 75 deletions docs/eppy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@ Subpackages
-----------

.. toctree::
:maxdepth: 4

eppy.results
eppy.runner
eppy.EPlusInterfaceFunctions
eppy.constructions
eppy.geometry
eppy.results
eppy.runner
eppy.useful_scripts

Submodules
----------
Expand All @@ -16,191 +21,190 @@ eppy.bunch\_subclass module
---------------------------

.. automodule:: eppy.bunch_subclass
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.bunchhelpers module
------------------------

.. automodule:: eppy.bunchhelpers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.easyopen module
--------------------

.. automodule:: eppy.easyopen
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.eppy module
----------------

.. automodule:: eppy.eppy
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.fanpower module
--------------------

.. automodule:: eppy.fanpower
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.function\_helpers module
-----------------------------

.. automodule:: eppy.function_helpers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.hvacbuilder module
-----------------------

.. automodule:: eppy.hvacbuilder
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.idd\_helpers module
------------------------

.. automodule:: eppy.idd_helpers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.iddcurrent module
----------------------

.. automodule:: eppy.iddcurrent
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.iddgaps module
-------------------

.. automodule:: eppy.iddgaps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.iddv7 module
-----------------

.. automodule:: eppy.iddv7
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.iddv800 module
-------------------

.. automodule:: eppy.iddv800
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.idf\_helpers module
------------------------

.. automodule:: eppy.idf_helpers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.idf\_msequence module
--------------------------

.. automodule:: eppy.idf_msequence
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.idfreader module
---------------------

.. automodule:: eppy.idfreader
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.json\_functions module
---------------------------

.. automodule:: eppy.json_functions
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.loops module
-----------------

.. automodule:: eppy.loops
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.modeleditor module
-----------------------

.. automodule:: eppy.modeleditor
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.pytest\_helpers module
---------------------------

.. automodule:: eppy.pytest_helpers
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.simpleread module
----------------------

.. automodule:: eppy.simpleread
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.simplesurface module
-------------------------

.. automodule:: eppy.simplesurface
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.snippet module
-------------------

.. automodule:: eppy.snippet
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

eppy.walk\_hvac module
----------------------

.. automodule:: eppy.walk_hvac
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: eppy
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit cc649e4

Please sign in to comment.