deploy: update docs

ladybug-tools · Nov 6, 2024 · 24e30b3 · 24e30b3
commit 24e30b3
Show file tree

Hide file tree

Showing 170 changed files with 47,500 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -0,0 +1 @@
+
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+# documentation
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -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: f1812a7a2d793992a7afcf3b23f8cfdb
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/cli/index.doctree b/docs/.doctrees/cli/index.doctree
diff --git a/docs/.doctrees/cli/simulate.doctree b/docs/.doctrees/cli/simulate.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.cli.doctree b/docs/.doctrees/dragonfly_uwg.cli.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.cli.simulate.doctree b/docs/.doctrees/dragonfly_uwg.cli.simulate.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.doctree b/docs/.doctrees/dragonfly_uwg.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.building.doctree b/docs/.doctrees/dragonfly_uwg.properties.building.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.context.doctree b/docs/.doctrees/dragonfly_uwg.properties.context.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.doctree b/docs/.doctrees/dragonfly_uwg.properties.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.model.doctree b/docs/.doctrees/dragonfly_uwg.properties.model.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.room2d.doctree b/docs/.doctrees/dragonfly_uwg.properties.room2d.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.properties.story.doctree b/docs/.doctrees/dragonfly_uwg.properties.story.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.run.doctree b/docs/.doctrees/dragonfly_uwg.run.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.boundary.doctree b/docs/.doctrees/dragonfly_uwg.simulation.boundary.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.doctree b/docs/.doctrees/dragonfly_uwg.simulation.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.parameter.doctree b/docs/.doctrees/dragonfly_uwg.simulation.parameter.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.refsite.doctree b/docs/.doctrees/dragonfly_uwg.simulation.refsite.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.runperiod.doctree b/docs/.doctrees/dragonfly_uwg.simulation.runperiod.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.simulation.vegetation.doctree b/docs/.doctrees/dragonfly_uwg.simulation.vegetation.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.terrain.doctree b/docs/.doctrees/dragonfly_uwg.terrain.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.traffic.doctree b/docs/.doctrees/dragonfly_uwg.traffic.doctree
diff --git a/docs/.doctrees/dragonfly_uwg.writer.doctree b/docs/.doctrees/dragonfly_uwg.writer.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+# documentation
diff --git a/docs/_modules/dragonfly_uwg/properties/building.html b/docs/_modules/dragonfly_uwg/properties/building.html
diff --git a/docs/_modules/dragonfly_uwg/properties/context.html b/docs/_modules/dragonfly_uwg/properties/context.html
diff --git a/docs/_modules/dragonfly_uwg/properties/model.html b/docs/_modules/dragonfly_uwg/properties/model.html
diff --git a/docs/_modules/dragonfly_uwg/properties/room2d.html b/docs/_modules/dragonfly_uwg/properties/room2d.html
diff --git a/docs/_modules/dragonfly_uwg/properties/story.html b/docs/_modules/dragonfly_uwg/properties/story.html
diff --git a/docs/_modules/dragonfly_uwg/run.html b/docs/_modules/dragonfly_uwg/run.html
diff --git a/docs/_modules/dragonfly_uwg/simulation/boundary.html b/docs/_modules/dragonfly_uwg/simulation/boundary.html
diff --git a/docs/_modules/dragonfly_uwg/simulation/parameter.html b/docs/_modules/dragonfly_uwg/simulation/parameter.html
diff --git a/docs/_modules/dragonfly_uwg/simulation/refsite.html b/docs/_modules/dragonfly_uwg/simulation/refsite.html
diff --git a/docs/_modules/dragonfly_uwg/simulation/runperiod.html b/docs/_modules/dragonfly_uwg/simulation/runperiod.html
diff --git a/docs/_modules/dragonfly_uwg/simulation/vegetation.html b/docs/_modules/dragonfly_uwg/simulation/vegetation.html
diff --git a/docs/_modules/dragonfly_uwg/terrain.html b/docs/_modules/dragonfly_uwg/terrain.html
diff --git a/docs/_modules/dragonfly_uwg/traffic.html b/docs/_modules/dragonfly_uwg/traffic.html
diff --git a/docs/_modules/dragonfly_uwg/writer.html b/docs/_modules/dragonfly_uwg/writer.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,14 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the command line is installed correctly use ``dragonfly-uwg --help``
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   simulate
diff --git a/docs/_sources/cli/simulate.rst.txt b/docs/_sources/cli/simulate.rst.txt
@@ -0,0 +1,6 @@
+simulate
+========
+
+.. click:: dragonfly_uwg.cli.simulate:simulate
+   :prog: dragonfly-uwg simulate
+   :show-nested:
diff --git a/docs/_sources/dragonfly_uwg.cli.rst.txt b/docs/_sources/dragonfly_uwg.cli.rst.txt
@@ -0,0 +1,18 @@
+dragonfly\_uwg.cli package
+==========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg.cli.simulate
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_uwg.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.cli.simulate.rst.txt b/docs/_sources/dragonfly_uwg.cli.simulate.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.cli.simulate module
+==================================
+
+.. automodule:: dragonfly_uwg.cli.simulate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.building.rst.txt b/docs/_sources/dragonfly_uwg.properties.building.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.properties.building module
+=========================================
+
+.. automodule:: dragonfly_uwg.properties.building
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.context.rst.txt b/docs/_sources/dragonfly_uwg.properties.context.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.properties.context module
+========================================
+
+.. automodule:: dragonfly_uwg.properties.context
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.model.rst.txt b/docs/_sources/dragonfly_uwg.properties.model.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.properties.model module
+======================================
+
+.. automodule:: dragonfly_uwg.properties.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.room2d.rst.txt b/docs/_sources/dragonfly_uwg.properties.room2d.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.properties.room2d module
+=======================================
+
+.. automodule:: dragonfly_uwg.properties.room2d
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.rst.txt b/docs/_sources/dragonfly_uwg.properties.rst.txt
@@ -0,0 +1,22 @@
+dragonfly\_uwg.properties package
+=================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg.properties.building
+   dragonfly_uwg.properties.context
+   dragonfly_uwg.properties.model
+   dragonfly_uwg.properties.room2d
+   dragonfly_uwg.properties.story
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_uwg.properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.properties.story.rst.txt b/docs/_sources/dragonfly_uwg.properties.story.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.properties.story module
+======================================
+
+.. automodule:: dragonfly_uwg.properties.story
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.rst.txt b/docs/_sources/dragonfly_uwg.rst.txt
@@ -0,0 +1,31 @@
+dragonfly\_uwg package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg.cli
+   dragonfly_uwg.properties
+   dragonfly_uwg.simulation
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg.run
+   dragonfly_uwg.terrain
+   dragonfly_uwg.traffic
+   dragonfly_uwg.writer
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_uwg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.run.rst.txt b/docs/_sources/dragonfly_uwg.run.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.run module
+=========================
+
+.. automodule:: dragonfly_uwg.run
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.boundary.rst.txt b/docs/_sources/dragonfly_uwg.simulation.boundary.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.simulation.boundary module
+=========================================
+
+.. automodule:: dragonfly_uwg.simulation.boundary
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.parameter.rst.txt b/docs/_sources/dragonfly_uwg.simulation.parameter.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.simulation.parameter module
+==========================================
+
+.. automodule:: dragonfly_uwg.simulation.parameter
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.refsite.rst.txt b/docs/_sources/dragonfly_uwg.simulation.refsite.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.simulation.refsite module
+========================================
+
+.. automodule:: dragonfly_uwg.simulation.refsite
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.rst.txt b/docs/_sources/dragonfly_uwg.simulation.rst.txt
@@ -0,0 +1,22 @@
+dragonfly\_uwg.simulation package
+=================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg.simulation.boundary
+   dragonfly_uwg.simulation.parameter
+   dragonfly_uwg.simulation.refsite
+   dragonfly_uwg.simulation.runperiod
+   dragonfly_uwg.simulation.vegetation
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_uwg.simulation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.runperiod.rst.txt b/docs/_sources/dragonfly_uwg.simulation.runperiod.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.simulation.runperiod module
+==========================================
+
+.. automodule:: dragonfly_uwg.simulation.runperiod
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.simulation.vegetation.rst.txt b/docs/_sources/dragonfly_uwg.simulation.vegetation.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.simulation.vegetation module
+===========================================
+
+.. automodule:: dragonfly_uwg.simulation.vegetation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.terrain.rst.txt b/docs/_sources/dragonfly_uwg.terrain.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.terrain module
+=============================
+
+.. automodule:: dragonfly_uwg.terrain
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.traffic.rst.txt b/docs/_sources/dragonfly_uwg.traffic.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.traffic module
+=============================
+
+.. automodule:: dragonfly_uwg.traffic
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_uwg.writer.rst.txt b/docs/_sources/dragonfly_uwg.writer.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_uwg.writer module
+============================
+
+.. automodule:: dragonfly_uwg.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,45 @@
+Welcome to dragonfly-uwg's documentation!
+===================================
+
+.. image:: http://www.ladybug.tools/assets/img/dragonfly.png
+
+`Urban Weather Generator <https://github.com/ladybug-tools/uwg>`_ extension for `dragonfly <https://github.com/ladybug-tools/dragonfly-core/>`_
+
+Dragonfly-uwg adds Urban Weather Generator functionalities to dragonfly.
+
+
+Installation
+============
+
+``pip install -U dragonfly-uwg``.
+
+To check if the command line is installed correctly use ``dragonfly-uwg --help``
+
+
+
+CLI Docs
+=============
+
+For command line interface documentation and API documentation see the pages below.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   cli/index
+
+
+dragonfly_uwg
+=============
+
+.. toctree::
+  :maxdepth: 4
+
+  modules
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+dragonfly_uwg
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_uwg