-
Notifications
You must be signed in to change notification settings - Fork 20
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: e64531a24038b05942fe986a0a0213fd | ||
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.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
datacollection | ||
============== | ||
|
||
.. click:: ladybug_comfort.cli.datacollection:datacollection | ||
:prog: ladybug-comfort data-collection | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
epw | ||
=== | ||
|
||
.. click:: ladybug_comfort.cli.epw:epw | ||
:prog: ladybug-comfort epw | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line is installed correctly use ``ladybug-comfort --help`` | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
map | ||
mtx | ||
epw | ||
datacollection | ||
sql |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
map | ||
=== | ||
|
||
.. click:: ladybug_comfort.cli.map:map | ||
:prog: ladybug-comfort map | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
mtx | ||
=== | ||
|
||
.. click:: ladybug_comfort.cli.mtx:mtx | ||
:prog: ladybug-comfort mtx | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
sql | ||
=== | ||
|
||
.. click:: ladybug_comfort.cli.sql:sql | ||
:prog: ladybug-comfort sql | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
Welcome to Ladybug Comfort's documentation! | ||
=========================================== | ||
|
||
.. image:: http://www.ladybug.tools/assets/img/ladybug.png | ||
|
||
Ladybug-comfort is a Python library that adds thermal comfort functionalities to | ||
`ladybug-core <https://github.com/ladybug-tools/ladybug/>`_. | ||
|
||
Installation | ||
============ | ||
|
||
``pip install -U ladybug-comfort`` | ||
|
||
If you want to also include the dependencies needed for thermal mapping use. | ||
|
||
``pip install -U honeybee-energy[mapping]`` | ||
|
||
To check if the command line interface is installed correctly use ``ladybug-comfort --help`` | ||
|
||
|
||
CLI Docs | ||
============= | ||
|
||
For command line interface documentation and API documentation see the pages below. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
cli/index | ||
|
||
|
||
ladybug_comfort | ||
=============== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
modules | ||
|
||
Indices and tables | ||
------------------ | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.adaptive module | ||
================================ | ||
|
||
.. automodule:: ladybug_comfort.adaptive | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.asv module | ||
=========================== | ||
|
||
.. automodule:: ladybug_comfort.asv | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.at module | ||
========================== | ||
|
||
.. automodule:: ladybug_comfort.at | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.chart.adaptive module | ||
====================================== | ||
|
||
.. automodule:: ladybug_comfort.chart.adaptive | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.chart.polygonpmv module | ||
======================================== | ||
|
||
.. automodule:: ladybug_comfort.chart.polygonpmv | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.chart.polygonutci module | ||
========================================= | ||
|
||
.. automodule:: ladybug_comfort.chart.polygonutci | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
ladybug\_comfort.chart package | ||
============================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_comfort.chart.adaptive | ||
ladybug_comfort.chart.polygonpmv | ||
ladybug_comfort.chart.polygonutci | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_comfort.chart | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.cli.datacollection module | ||
========================================== | ||
|
||
.. automodule:: ladybug_comfort.cli.datacollection | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.cli.epw module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.cli.epw | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.cli.map module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.cli.map | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.cli.mtx module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.cli.mtx | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
ladybug\_comfort.cli package | ||
============================ | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_comfort.cli.datacollection | ||
ladybug_comfort.cli.epw | ||
ladybug_comfort.cli.map | ||
ladybug_comfort.cli.mtx | ||
ladybug_comfort.cli.sql | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_comfort.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.cli.sql module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.cli.sql | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.clo module | ||
=========================== | ||
|
||
.. automodule:: ladybug_comfort.clo | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.adaptive module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_comfort.collection.adaptive | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.base module | ||
======================================= | ||
|
||
.. automodule:: ladybug_comfort.collection.base | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.pet module | ||
====================================== | ||
|
||
.. automodule:: ladybug_comfort.collection.pet | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.pmv module | ||
====================================== | ||
|
||
.. automodule:: ladybug_comfort.collection.pmv | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
ladybug\_comfort.collection package | ||
=================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_comfort.collection.adaptive | ||
ladybug_comfort.collection.base | ||
ladybug_comfort.collection.pet | ||
ladybug_comfort.collection.pmv | ||
ladybug_comfort.collection.solarcal | ||
ladybug_comfort.collection.utci | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_comfort.collection | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.solarcal module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_comfort.collection.solarcal | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.collection.utci module | ||
======================================= | ||
|
||
.. automodule:: ladybug_comfort.collection.utci | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.degreetime module | ||
================================== | ||
|
||
.. automodule:: ladybug_comfort.degreetime | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.di module | ||
========================== | ||
|
||
.. automodule:: ladybug_comfort.di | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.hi module | ||
========================== | ||
|
||
.. automodule:: ladybug_comfort.hi | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.humidex module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.humidex | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.local module | ||
============================= | ||
|
||
.. automodule:: ladybug_comfort.local | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.map.air module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.map.air | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.map.irr module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.map.irr | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_comfort.map.mrt module | ||
=============================== | ||
|
||
.. automodule:: ladybug_comfort.map.mrt | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |