-
Notifications
You must be signed in to change notification settings - Fork 10
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: c7b296a0740abd9c3216116f9e16aeb0 | ||
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.
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.
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.
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,6 @@ | ||
dc | ||
== | ||
|
||
.. click:: honeybee_radiance.cli.dc:dc | ||
:prog: honeybee-radiance dc | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
edit | ||
==== | ||
|
||
.. click:: honeybee_radiance.cli.edit:edit | ||
:prog: honeybee-radiance edit | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
glare | ||
===== | ||
|
||
.. click:: honeybee_radiance.cli.glare:dcglare | ||
:prog: honeybee-radiance dcglare | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
grid | ||
==== | ||
|
||
.. click:: honeybee_radiance.cli.grid:grid | ||
:prog: honeybee-radiance grid | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line interface is installed correctly use `honeybee-radiance --help`. | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
main | ||
octree | ||
edit | ||
viewfactor | ||
lib | ||
grid | ||
multiphase | ||
translate | ||
setconfig | ||
mtx | ||
sky | ||
threephase | ||
glare | ||
postprocess | ||
schedule | ||
rpict | ||
sunpath | ||
dc | ||
raytrace | ||
view |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
lib | ||
=== | ||
|
||
.. click:: honeybee_radiance.cli.lib:lib | ||
:prog: honeybee-radiance lib | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
main | ||
==== | ||
|
||
.. click:: honeybee_radiance.cli.__init__:radiance | ||
:prog: honeybee-radiance | ||
:show-nested: | ||
:commands: config |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
mtx | ||
=== | ||
|
||
.. click:: honeybee_radiance.cli.mtx:mtxop | ||
:prog: honeybee-radiance mtxop | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
multiphase | ||
========== | ||
|
||
.. click:: honeybee_radiance.cli.multiphase:multi_phase | ||
:prog: honeybee-radiance multi_phase | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
octree | ||
====== | ||
|
||
.. click:: honeybee_radiance.cli.octree:octree | ||
:prog: honeybee-radiance octree | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
postprocess | ||
=========== | ||
|
||
.. click:: honeybee_radiance.cli.postprocess:post_process | ||
:prog: honeybee-radiance post-process | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
raytrace | ||
======== | ||
|
||
.. click:: honeybee_radiance.cli.raytrace:raytrace | ||
:prog: honeybee-radiance raytrace | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
rpict | ||
===== | ||
|
||
.. click:: honeybee_radiance.cli.rpict:rpict | ||
:prog: honeybee-radiance rpict | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
schedule | ||
======== | ||
|
||
.. click:: honeybee_radiance.cli.schedule:schedule | ||
:prog: honeybee-radiance schedule | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
setconfig | ||
========= | ||
|
||
.. click:: honeybee_radiance.cli.setconfig:set_config | ||
:prog: honeybee-radiance set-config | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
sky | ||
=== | ||
|
||
.. click:: honeybee_radiance.cli.sky:sky | ||
:prog: honeybee-radiance sky | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
sunpath | ||
======= | ||
|
||
.. click:: honeybee_radiance.cli.sunpath:sunpath | ||
:prog: honeybee-radiance sunpath | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
threephase | ||
========== | ||
|
||
.. click:: honeybee_radiance.cli.threephase:three_phase | ||
:prog: honeybee-radiance three_phase | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
translate | ||
========= | ||
|
||
.. click:: honeybee_radiance.cli.translate:translate | ||
:prog: honeybee-radiance translate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
view | ||
==== | ||
|
||
.. click:: honeybee_radiance.cli.view:view | ||
:prog: honeybee-radiance view | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
viewfactor | ||
========== | ||
|
||
.. click:: honeybee_radiance.cli.viewfactor:view_factor | ||
:prog: honeybee-radiance view_factor | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.dc module | ||
================================ | ||
|
||
.. automodule:: honeybee_radiance.cli.dc | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.edit module | ||
================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.edit | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.glare module | ||
=================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.glare | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.grid module | ||
================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.grid | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.lib module | ||
================================= | ||
|
||
.. automodule:: honeybee_radiance.cli.lib | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.mtx module | ||
================================= | ||
|
||
.. automodule:: honeybee_radiance.cli.mtx | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.multiphase module | ||
======================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.multiphase | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.octree module | ||
==================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.octree | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.postprocess module | ||
========================================= | ||
|
||
.. automodule:: honeybee_radiance.cli.postprocess | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.raytrace module | ||
====================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.raytrace | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.rpict module | ||
=================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.rpict | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
honeybee\_radiance.cli package | ||
============================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
honeybee_radiance.cli.dc | ||
honeybee_radiance.cli.edit | ||
honeybee_radiance.cli.glare | ||
honeybee_radiance.cli.grid | ||
honeybee_radiance.cli.lib | ||
honeybee_radiance.cli.mtx | ||
honeybee_radiance.cli.multiphase | ||
honeybee_radiance.cli.octree | ||
honeybee_radiance.cli.postprocess | ||
honeybee_radiance.cli.raytrace | ||
honeybee_radiance.cli.rpict | ||
honeybee_radiance.cli.schedule | ||
honeybee_radiance.cli.setconfig | ||
honeybee_radiance.cli.sky | ||
honeybee_radiance.cli.sunpath | ||
honeybee_radiance.cli.threephase | ||
honeybee_radiance.cli.translate | ||
honeybee_radiance.cli.util | ||
honeybee_radiance.cli.view | ||
honeybee_radiance.cli.viewfactor | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: honeybee_radiance.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_radiance.cli.schedule module | ||
====================================== | ||
|
||
.. automodule:: honeybee_radiance.cli.schedule | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |