104 lines
2.0 KiB
ReStructuredText
104 lines
2.0 KiB
ReStructuredText
.. CERC libs documentation master file, created by
|
|
sphinx-quickstart on Mon Jun 15 09:17:03 2020.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to CERC libs's documentation!
|
|
=====================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 5
|
|
:caption: Contents:
|
|
|
|
Indices and tables
|
|
====================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
City Model Structure
|
|
====================
|
|
|
|
City
|
|
********************
|
|
.. automodule:: city_model_structure.city
|
|
:members:
|
|
|
|
City Object
|
|
********************
|
|
.. automodule:: city_model_structure.city_object
|
|
:members:
|
|
|
|
Internal Gains
|
|
********************
|
|
.. automodule:: city_model_structure.internal_gains
|
|
:members:
|
|
|
|
Layer
|
|
********************
|
|
.. automodule:: city_model_structure.layer
|
|
:members:
|
|
|
|
Material
|
|
********************
|
|
.. automodule:: city_model_structure.material
|
|
:members:
|
|
|
|
Polyhedron
|
|
********************
|
|
.. automodule:: city_model_structure.polyhedron
|
|
:members:
|
|
|
|
Surface
|
|
********************
|
|
.. automodule:: city_model_structure.surface
|
|
:members:
|
|
|
|
Thermal Boundary
|
|
********************
|
|
.. automodule:: city_model_structure.thermal_boundary
|
|
:members:
|
|
|
|
Thermal Opening
|
|
********************
|
|
.. automodule:: city_model_structure.thermal_opening
|
|
:members:
|
|
|
|
Thermal Zone
|
|
********************
|
|
.. automodule:: city_model_structure.thermal_zone
|
|
:members:
|
|
|
|
Usage Zone
|
|
********************
|
|
.. automodule:: city_model_structure.usage_zone
|
|
:members:
|
|
|
|
Factories
|
|
====================
|
|
|
|
Geometry Factory
|
|
********************
|
|
.. automodule:: geometry.geometry_factory
|
|
:members:
|
|
|
|
Physics Factory
|
|
********************
|
|
.. automodule:: physics.physics_factory
|
|
:members:
|
|
|
|
Usage Factory
|
|
********************
|
|
.. automodule:: usage.usage_factory
|
|
:members:
|
|
|
|
|
|
Additional Files
|
|
====================
|
|
|
|
:download:`README.md<../../README.md>`
|
|
:download:`LICENSE.md<../../LICENSE.md>`
|
|
:download:`CODE_OF_CONDUCT.md<../../CODE_OF_CONDUCT.md>`
|
|
:download:`CONTRIBUTING.md<../../CONTRIBUTING.md>`
|
|
:download:`PYGUIDE.md<../../PYGUIDE.md>` |