-
Notifications
You must be signed in to change notification settings - Fork 26
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: e2de6db9c7f12a31c35d4496f4989504 | ||
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.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
simulate | ||
======== | ||
|
||
.. click:: uwg.cli.simulate:simulate | ||
:prog: uwg simulate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
validate | ||
======== | ||
|
||
.. click:: uwg.cli.validate:validate | ||
:prog: uwg validate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg | ||
=== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
uwg |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.BEMDef module | ||
================= | ||
|
||
.. automodule:: uwg.BEMDef | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.RSMDef module | ||
================= | ||
|
||
.. automodule:: uwg.RSMDef | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.UBLDef module | ||
================= | ||
|
||
.. automodule:: uwg.UBLDef | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.UCMDef module | ||
================= | ||
|
||
.. automodule:: uwg.UCMDef | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.building module | ||
=================== | ||
|
||
.. automodule:: uwg.building | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.cli.simulate module | ||
======================= | ||
|
||
.. automodule:: uwg.cli.simulate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.cli.validate module | ||
======================= | ||
|
||
.. automodule:: uwg.cli.validate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.element module | ||
================== | ||
|
||
.. automodule:: uwg.element | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.forcing module | ||
================== | ||
|
||
.. automodule:: uwg.forcing | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.infracalcs module | ||
===================== | ||
|
||
.. automodule:: uwg.infracalcs | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.material module | ||
=================== | ||
|
||
.. automodule:: uwg.material | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.param module | ||
================ | ||
|
||
.. automodule:: uwg.param | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.psychrometrics module | ||
========================= | ||
|
||
.. automodule:: uwg.psychrometrics | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.readDOE module | ||
================== | ||
|
||
.. automodule:: uwg.readDOE | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.schdef module | ||
================= | ||
|
||
.. automodule:: uwg.schdef | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.simparam module | ||
=================== | ||
|
||
.. automodule:: uwg.simparam | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.solarcalcs module | ||
===================== | ||
|
||
.. automodule:: uwg.solarcalcs | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.urbflux module | ||
================== | ||
|
||
.. automodule:: uwg.urbflux | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.utilities module | ||
==================== | ||
|
||
.. automodule:: uwg.utilities | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.uwg module | ||
============== | ||
|
||
.. automodule:: uwg.uwg | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uwg.weather module | ||
================== | ||
|
||
.. automodule:: uwg.weather | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |