-
-
Notifications
You must be signed in to change notification settings - Fork 54
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 @@ | ||
# place holder for 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: d2682bcc0f6726143405af33cdcb025d | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# place holder for 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.
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 ``ladybug --help`` | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
main | ||
setconfig | ||
translate |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
main | ||
==== | ||
|
||
.. click:: ladybug.cli.__init__:main | ||
:prog: ladybug | ||
:show-nested: | ||
:commands: config ,viz |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
setconfig | ||
========= | ||
|
||
.. click:: ladybug.cli.setconfig:set_config | ||
:prog: ladybug set-config | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
translate | ||
========= | ||
|
||
.. click:: ladybug.cli.translate:translate | ||
:prog: ladybug translate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Welcome to Ladybug's documentation! | ||
=================================== | ||
|
||
.. image:: http://www.ladybug.tools/assets/img/ladybug.png | ||
|
||
Ladybug is a Python library to load, analyze and modify EnergyPlus Weather files (epw). | ||
|
||
You can download epw files from `EPWMap <http://www.ladybug.tools/epwmap/>`_. | ||
|
||
Installation | ||
============ | ||
|
||
``pip install -U ladybug-core`` | ||
|
||
|
||
CLI Docs | ||
============= | ||
|
||
For command line interface documentation and API documentation see the pages below. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
cli/index | ||
|
||
|
||
ladybug | ||
======= | ||
|
||
.. 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.analysisperiod module | ||
============================= | ||
|
||
.. automodule:: ladybug.analysisperiod | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
ladybug.cli package | ||
=================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug.cli.setconfig | ||
ladybug.cli.translate | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.cli.setconfig module | ||
============================ | ||
|
||
.. automodule:: ladybug.cli.setconfig | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.cli.translate module | ||
============================ | ||
|
||
.. automodule:: ladybug.cli.translate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.climatezone module | ||
========================== | ||
|
||
.. automodule:: ladybug.climatezone | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.color module | ||
==================== | ||
|
||
.. automodule:: ladybug.color | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.commandutil module | ||
========================== | ||
|
||
.. automodule:: ladybug.commandutil | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.compass module | ||
====================== | ||
|
||
.. automodule:: ladybug.compass | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.config module | ||
===================== | ||
|
||
.. automodule:: ladybug.config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datacollection module | ||
============================= | ||
|
||
.. automodule:: ladybug.datacollection | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datacollectionimmutable module | ||
====================================== | ||
|
||
.. automodule:: ladybug.datacollectionimmutable | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.angle module | ||
============================= | ||
|
||
.. automodule:: ladybug.datatype.angle | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.area module | ||
============================ | ||
|
||
.. automodule:: ladybug.datatype.area | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.base module | ||
============================ | ||
|
||
.. automodule:: ladybug.datatype.base | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.current module | ||
=============================== | ||
|
||
.. automodule:: ladybug.datatype.current | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.distance module | ||
================================ | ||
|
||
.. automodule:: ladybug.datatype.distance | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.energy module | ||
============================== | ||
|
||
.. automodule:: ladybug.datatype.energy | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.energyflux module | ||
================================== | ||
|
||
.. automodule:: ladybug.datatype.energyflux | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.energyintensity module | ||
======================================= | ||
|
||
.. automodule:: ladybug.datatype.energyintensity | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.fraction module | ||
================================ | ||
|
||
.. automodule:: ladybug.datatype.fraction | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.generic module | ||
=============================== | ||
|
||
.. automodule:: ladybug.datatype.generic | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.illuminance module | ||
=================================== | ||
|
||
.. automodule:: ladybug.datatype.illuminance | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.luminance module | ||
================================= | ||
|
||
.. automodule:: ladybug.datatype.luminance | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.mass module | ||
============================ | ||
|
||
.. automodule:: ladybug.datatype.mass | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.massflowrate module | ||
==================================== | ||
|
||
.. automodule:: ladybug.datatype.massflowrate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.power module | ||
============================= | ||
|
||
.. automodule:: ladybug.datatype.power | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.pressure module | ||
================================ | ||
|
||
.. automodule:: ladybug.datatype.pressure | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
ladybug.datatype package | ||
======================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug.datatype.angle | ||
ladybug.datatype.area | ||
ladybug.datatype.base | ||
ladybug.datatype.current | ||
ladybug.datatype.distance | ||
ladybug.datatype.energy | ||
ladybug.datatype.energyflux | ||
ladybug.datatype.energyintensity | ||
ladybug.datatype.fraction | ||
ladybug.datatype.generic | ||
ladybug.datatype.illuminance | ||
ladybug.datatype.luminance | ||
ladybug.datatype.mass | ||
ladybug.datatype.massflowrate | ||
ladybug.datatype.power | ||
ladybug.datatype.pressure | ||
ladybug.datatype.rvalue | ||
ladybug.datatype.specificenergy | ||
ladybug.datatype.speed | ||
ladybug.datatype.temperature | ||
ladybug.datatype.temperaturedelta | ||
ladybug.datatype.temperaturetime | ||
ladybug.datatype.thermalcondition | ||
ladybug.datatype.time | ||
ladybug.datatype.uvalue | ||
ladybug.datatype.voltage | ||
ladybug.datatype.volume | ||
ladybug.datatype.volumeflowrate | ||
ladybug.datatype.volumeflowrateintensity | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug.datatype | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.rvalue module | ||
============================== | ||
|
||
.. automodule:: ladybug.datatype.rvalue | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.specificenergy module | ||
====================================== | ||
|
||
.. automodule:: ladybug.datatype.specificenergy | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.speed module | ||
============================= | ||
|
||
.. automodule:: ladybug.datatype.speed | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug.datatype.temperature module | ||
=================================== | ||
|
||
.. automodule:: ladybug.datatype.temperature | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |