deploy: update docs

ladybug-tools · Oct 15, 2024 · 4bf06a8 · 4bf06a8
commit 4bf06a8
Show file tree

Hide file tree

Showing 190 changed files with 60,247 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: 58577eb06bae476b9b640b3d90502b1b
+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/cli/validate.doctree b/docs/.doctrees/cli/validate.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/.doctrees/uwg.BEMDef.doctree b/docs/.doctrees/uwg.BEMDef.doctree
diff --git a/docs/.doctrees/uwg.RSMDef.doctree b/docs/.doctrees/uwg.RSMDef.doctree
diff --git a/docs/.doctrees/uwg.UBLDef.doctree b/docs/.doctrees/uwg.UBLDef.doctree
diff --git a/docs/.doctrees/uwg.UCMDef.doctree b/docs/.doctrees/uwg.UCMDef.doctree
diff --git a/docs/.doctrees/uwg.building.doctree b/docs/.doctrees/uwg.building.doctree
diff --git a/docs/.doctrees/uwg.cli.doctree b/docs/.doctrees/uwg.cli.doctree
diff --git a/docs/.doctrees/uwg.cli.simulate.doctree b/docs/.doctrees/uwg.cli.simulate.doctree
diff --git a/docs/.doctrees/uwg.cli.validate.doctree b/docs/.doctrees/uwg.cli.validate.doctree
diff --git a/docs/.doctrees/uwg.doctree b/docs/.doctrees/uwg.doctree
diff --git a/docs/.doctrees/uwg.element.doctree b/docs/.doctrees/uwg.element.doctree
diff --git a/docs/.doctrees/uwg.forcing.doctree b/docs/.doctrees/uwg.forcing.doctree
diff --git a/docs/.doctrees/uwg.infracalcs.doctree b/docs/.doctrees/uwg.infracalcs.doctree
diff --git a/docs/.doctrees/uwg.material.doctree b/docs/.doctrees/uwg.material.doctree
diff --git a/docs/.doctrees/uwg.param.doctree b/docs/.doctrees/uwg.param.doctree
diff --git a/docs/.doctrees/uwg.psychrometrics.doctree b/docs/.doctrees/uwg.psychrometrics.doctree
diff --git a/docs/.doctrees/uwg.readDOE.doctree b/docs/.doctrees/uwg.readDOE.doctree
diff --git a/docs/.doctrees/uwg.schdef.doctree b/docs/.doctrees/uwg.schdef.doctree
diff --git a/docs/.doctrees/uwg.simparam.doctree b/docs/.doctrees/uwg.simparam.doctree
diff --git a/docs/.doctrees/uwg.solarcalcs.doctree b/docs/.doctrees/uwg.solarcalcs.doctree
diff --git a/docs/.doctrees/uwg.urbflux.doctree b/docs/.doctrees/uwg.urbflux.doctree
diff --git a/docs/.doctrees/uwg.utilities.doctree b/docs/.doctrees/uwg.utilities.doctree
diff --git a/docs/.doctrees/uwg.uwg.doctree b/docs/.doctrees/uwg.uwg.doctree
diff --git a/docs/.doctrees/uwg.weather.doctree b/docs/.doctrees/uwg.weather.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/index.html b/docs/_modules/index.html
diff --git a/docs/_modules/uwg/BEMDef.html b/docs/_modules/uwg/BEMDef.html
diff --git a/docs/_modules/uwg/RSMDef.html b/docs/_modules/uwg/RSMDef.html
diff --git a/docs/_modules/uwg/UBLDef.html b/docs/_modules/uwg/UBLDef.html
diff --git a/docs/_modules/uwg/UCMDef.html b/docs/_modules/uwg/UCMDef.html
diff --git a/docs/_modules/uwg/building.html b/docs/_modules/uwg/building.html
diff --git a/docs/_modules/uwg/element.html b/docs/_modules/uwg/element.html
diff --git a/docs/_modules/uwg/forcing.html b/docs/_modules/uwg/forcing.html
diff --git a/docs/_modules/uwg/infracalcs.html b/docs/_modules/uwg/infracalcs.html
diff --git a/docs/_modules/uwg/material.html b/docs/_modules/uwg/material.html
diff --git a/docs/_modules/uwg/param.html b/docs/_modules/uwg/param.html
diff --git a/docs/_modules/uwg/psychrometrics.html b/docs/_modules/uwg/psychrometrics.html
diff --git a/docs/_modules/uwg/readDOE.html b/docs/_modules/uwg/readDOE.html
diff --git a/docs/_modules/uwg/schdef.html b/docs/_modules/uwg/schdef.html
diff --git a/docs/_modules/uwg/simparam.html b/docs/_modules/uwg/simparam.html
diff --git a/docs/_modules/uwg/solarcalcs.html b/docs/_modules/uwg/solarcalcs.html
diff --git a/docs/_modules/uwg/urbflux.html b/docs/_modules/uwg/urbflux.html
diff --git a/docs/_modules/uwg/utilities.html b/docs/_modules/uwg/utilities.html
diff --git a/docs/_modules/uwg/uwg.html b/docs/_modules/uwg/uwg.html
diff --git a/docs/_modules/uwg/weather.html b/docs/_modules/uwg/weather.html
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,15 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the command line is installed correctly use ``uwg --help``
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   validate
+   simulate
diff --git a/docs/_sources/cli/simulate.rst.txt b/docs/_sources/cli/simulate.rst.txt
@@ -0,0 +1,6 @@
+simulate
+========
+
+.. click:: uwg.cli.simulate:simulate
+   :prog: uwg simulate
+   :show-nested:
diff --git a/docs/_sources/cli/validate.rst.txt b/docs/_sources/cli/validate.rst.txt
@@ -0,0 +1,6 @@
+validate
+========
+
+.. click:: uwg.cli.validate:validate
+   :prog: uwg validate
+   :show-nested:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,41 @@
+Welcome to uwg's documentation!
+===================================
+
+The Urban Weather Generator (uwg) is a Python application for modeling
+the `urban heat island effect <https://en.wikipedia.org/wiki/Urban_heat_island//>`_ .
+Specifically, it morphs rural `EnergyPlus weather (.epw) files <http://www.ladybug.tools/epwmap//>`_ 
+to reflect average conditions within the urban canyon using a range of properties.
+
+Installation
+============
+
+``pip install -U uwg``.
+
+To check if the command line is installed correctly use ``uwg --help``
+
+CLI Docs
+=============
+
+For command line interface documentation and API documentation see the pages below.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   cli/index
+
+
+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 @@
+uwg
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   uwg
diff --git a/docs/_sources/uwg.BEMDef.rst.txt b/docs/_sources/uwg.BEMDef.rst.txt
@@ -0,0 +1,7 @@
+uwg.BEMDef module
+=================
+
+.. automodule:: uwg.BEMDef
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.RSMDef.rst.txt b/docs/_sources/uwg.RSMDef.rst.txt
@@ -0,0 +1,7 @@
+uwg.RSMDef module
+=================
+
+.. automodule:: uwg.RSMDef
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.UBLDef.rst.txt b/docs/_sources/uwg.UBLDef.rst.txt
@@ -0,0 +1,7 @@
+uwg.UBLDef module
+=================
+
+.. automodule:: uwg.UBLDef
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.UCMDef.rst.txt b/docs/_sources/uwg.UCMDef.rst.txt
@@ -0,0 +1,7 @@
+uwg.UCMDef module
+=================
+
+.. automodule:: uwg.UCMDef
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.building.rst.txt b/docs/_sources/uwg.building.rst.txt
@@ -0,0 +1,7 @@
+uwg.building module
+===================
+
+.. automodule:: uwg.building
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.cli.rst.txt b/docs/_sources/uwg.cli.rst.txt
@@ -0,0 +1,19 @@
+uwg.cli package
+===============
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   uwg.cli.simulate
+   uwg.cli.validate
+
+Module contents
+---------------
+
+.. automodule:: uwg.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.cli.simulate.rst.txt b/docs/_sources/uwg.cli.simulate.rst.txt
@@ -0,0 +1,7 @@
+uwg.cli.simulate module
+=======================
+
+.. automodule:: uwg.cli.simulate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.cli.validate.rst.txt b/docs/_sources/uwg.cli.validate.rst.txt
@@ -0,0 +1,7 @@
+uwg.cli.validate module
+=======================
+
+.. automodule:: uwg.cli.validate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.element.rst.txt b/docs/_sources/uwg.element.rst.txt
@@ -0,0 +1,7 @@
+uwg.element module
+==================
+
+.. automodule:: uwg.element
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.forcing.rst.txt b/docs/_sources/uwg.forcing.rst.txt
@@ -0,0 +1,7 @@
+uwg.forcing module
+==================
+
+.. automodule:: uwg.forcing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.infracalcs.rst.txt b/docs/_sources/uwg.infracalcs.rst.txt
@@ -0,0 +1,7 @@
+uwg.infracalcs module
+=====================
+
+.. automodule:: uwg.infracalcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.material.rst.txt b/docs/_sources/uwg.material.rst.txt
@@ -0,0 +1,7 @@
+uwg.material module
+===================
+
+.. automodule:: uwg.material
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.param.rst.txt b/docs/_sources/uwg.param.rst.txt
@@ -0,0 +1,7 @@
+uwg.param module
+================
+
+.. automodule:: uwg.param
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.psychrometrics.rst.txt b/docs/_sources/uwg.psychrometrics.rst.txt
@@ -0,0 +1,7 @@
+uwg.psychrometrics module
+=========================
+
+.. automodule:: uwg.psychrometrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.readDOE.rst.txt b/docs/_sources/uwg.readDOE.rst.txt
@@ -0,0 +1,7 @@
+uwg.readDOE module
+==================
+
+.. automodule:: uwg.readDOE
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.rst.txt b/docs/_sources/uwg.rst.txt
@@ -0,0 +1,44 @@
+uwg package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   uwg.cli
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   uwg.BEMDef
+   uwg.RSMDef
+   uwg.UBLDef
+   uwg.UCMDef
+   uwg.building
+   uwg.element
+   uwg.forcing
+   uwg.infracalcs
+   uwg.material
+   uwg.param
+   uwg.psychrometrics
+   uwg.readDOE
+   uwg.schdef
+   uwg.simparam
+   uwg.solarcalcs
+   uwg.urbflux
+   uwg.utilities
+   uwg.uwg
+   uwg.weather
+
+Module contents
+---------------
+
+.. automodule:: uwg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.schdef.rst.txt b/docs/_sources/uwg.schdef.rst.txt
@@ -0,0 +1,7 @@
+uwg.schdef module
+=================
+
+.. automodule:: uwg.schdef
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.simparam.rst.txt b/docs/_sources/uwg.simparam.rst.txt
@@ -0,0 +1,7 @@
+uwg.simparam module
+===================
+
+.. automodule:: uwg.simparam
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.solarcalcs.rst.txt b/docs/_sources/uwg.solarcalcs.rst.txt
@@ -0,0 +1,7 @@
+uwg.solarcalcs module
+=====================
+
+.. automodule:: uwg.solarcalcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.urbflux.rst.txt b/docs/_sources/uwg.urbflux.rst.txt
@@ -0,0 +1,7 @@
+uwg.urbflux module
+==================
+
+.. automodule:: uwg.urbflux
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.utilities.rst.txt b/docs/_sources/uwg.utilities.rst.txt
@@ -0,0 +1,7 @@
+uwg.utilities module
+====================
+
+.. automodule:: uwg.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.uwg.rst.txt b/docs/_sources/uwg.uwg.rst.txt
@@ -0,0 +1,7 @@
+uwg.uwg module
+==============
+
+.. automodule:: uwg.uwg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/uwg.weather.rst.txt b/docs/_sources/uwg.weather.rst.txt
@@ -0,0 +1,7 @@
+uwg.weather module
+==================
+
+.. automodule:: uwg.weather
+   :members:
+   :undoc-members:
+   :show-inheritance: