Skip to content

Commit

Permalink
Moved tables to csv files and replaced with csv-table directive
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelduchesne committed Nov 22, 2017
1 parent b3ff154 commit f2bc2c6
Show file tree
Hide file tree
Showing 15 changed files with 472 additions and 201 deletions.
23 changes: 23 additions & 0 deletions docs/tables/conditioning.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"Setting", "Description", "Units", "Default Value"
":ref:`cond_heating`","Description"," "," "
":ref:`cond_h_setpoint`","Description"," "," "
":ref:`cond_h_schedule`","Description"," "," "
":ref:`cond_h_limit_type`","Description"," "," "
":ref:`cond_h_max_cap`","Description"," "," "
":ref:`cond_h_max_cap`","Description"," "," "
":ref:`cond_h_max_flow`","Description"," "," "
":ref:`cond_h_cop`","Description"," "," "
":ref:`cond_c_setpoint`","Description"," "," "
":ref:`cond_c_schedule`","Description"," "," "
":ref:`cond_c_limit_type`","Description"," "," "
":ref:`cond_c_max_cap`","Description"," "," "
":ref:`cond_c_max_flow`","Description"," "," "
":ref:`cond_c_cop`","Description"," "," "
":ref:`cond_mech_vent`","Description"," "," "
":ref:`cond_mv_schedule`","Description"," "," "
":ref:`cond_min_freshair_area`","Description"," "," "
":ref:`cond_min_freshair_pers`","Description"," "," "
":ref:`cond_econ_type`","Description"," "," "
":ref:`cond_hr_type`","Description"," "," "
":ref:`cond_hr_eff_latent`","Description"," "," "
":ref:`cond_hr_eff_sensible`","Description"," "," "
6 changes: 6 additions & 0 deletions docs/tables/dhw.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
"Setting","Description","Unit","Default Value"
":ref:`dhw_enabled`","Description"," "," "
":ref:`dhw_scheduled`","Description"," "," "
":ref:`dhw_setpoint`","Description"," "," "
":ref:`dhw_inlet_temp`","Description"," "," "
":ref:`dhw_flowrate`","Description"," "," "
12 changes: 12 additions & 0 deletions docs/tables/loads.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
"Setting","Description","Unit","Default Value"
":ref:`loads_people`","Description","Unit","Default Value"
":ref:`loads_occ_density`","Description"," "," "
":ref:`loads_occ_schedule`","Description"," "," "
":ref:`loads_equipment`","Description"," "," "
":ref:`loads_equipment_density`","Description"," "," "
":ref:`loads_equipement_schedule`","Description"," "," "
":ref:`loads_lighting`","Description"," "," "
":ref:`loads_lighting_density`","Description"," "," "
":ref:`loads_lighting_schedule`","Description"," "," "
":ref:`loads_dim_type`","Description"," "," "
":ref:`loads_ill_target` ","Description"," "," "
16 changes: 16 additions & 0 deletions docs/tables/ventilation.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"Setting","Description","Unit","Default Value"
":ref:`vent_infiltration`","Description","",""
":ref:`vent_infiltration_rate`","Description","",""
":ref:`vent_nat`","Description","",""
":ref:`vent_nat_min_outdoor_temp`","Description","",""
":ref:`vent_nat_max_outdoor_temp`","Description","",""
":ref:`vent_nat_max_rh`","Description","",""
":ref:`vent_nat_schedule`","Description","",""
":ref:`vent_nat_zone_temp_setpoint`","Description","",""
":ref:`vent_schduled`","Description","",""
":ref:`vent_scheduled_ach`","Description","",""
":ref:`vent_scheduled_schedule`","Description","",""
":ref:`vent_scheduled_setpoint`","Description","",""
":ref:`vent_buoyancy`","Description","",""
":ref:`vent_wind`","Description","",""
":ref:`vent_afn`","Description","",""
17 changes: 17 additions & 0 deletions docs/tables/windows.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"Setting","Description","Unit","Default Value"
":ref:`windows_type`","Description"," "," "
":ref:`windows_construction`","Description"," "," "
":ref:`windows_operable_area`","Description"," "," "
":ref:`windows_shading_used`","Description"," "," "
":ref:`windows_shading_schedule`","Description"," "," "
":ref:`windows_shading_setpoint`","Description"," "," "
":ref:`windows_shading_transmittance`","Description"," "," "
":ref:`windows_shading_type`","Description"," "," "
":ref:`windows_zone_mixing`","Description"," "," "
":ref:`windows_zone_mixing_schedule`","Description"," "," "
":ref:`windows_zone_mixing_schedule_delta_t`","Description"," "," "
":ref:`windows_zone_mixing_flowrate`","Description"," "," "
":ref:`windows_virtual_partition`","Description"," "," "
":ref:`windows_airflow_network_disch_coef`","Description"," "," "
":ref:`windows_airflow_network_setpoint`","Description"," "," "
":ref:`windows_airflow_network_availability`","Description"," "," "
11 changes: 11 additions & 0 deletions docs/tables/zoneinfo_constructions.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
"Setting","Description"
":ref:`zinfo_facade`",""
":ref:`zinfo_ground`",""
":ref:`zinfo_partition`",""
":ref:`zinfo_roof`",""
":ref:`zinfo_slab`",""
":ref:`zinfo_facade_adiabatic`",""
":ref:`zinfo_ground_adiabatic`",""
":ref:`zinfo_partition_adiabatic`",""
":ref:`zinfo_roof_adiabatic`",""
":ref:`zinfo_slab_adiabatic`",""
10 changes: 10 additions & 0 deletions docs/tables/zones.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
"Setting","Description","Unit","Default Value"
":ref:`zones_constructions`","Description"," "," "
":ref:`zones_loads`","Description"," "," "
":ref:`zones_Conditioning`","Description"," "," "
":ref:`zones_Ventilation`","Description"," "," "
":ref:`zones_dhw`","Description"," "," "
":ref:`zones_daylight-mesh-res`","Description"," "," "
":ref:`zones_daylight-work-height`","Description"," "," "
":ref:`zones_internal-mass-construction`","Description"," "," "
":ref:`zones_internal-mass-exposed-floor`","Description"," "," "
36 changes: 36 additions & 0 deletions docs/template-info/Zone-Information/_zoneinfo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,42 @@ Zone Information Tab

This section provide details on the Zone Information tab

.. csv-table:: Zone tab parameters
:file: ../../tables/zones.csv
:header-rows: 1
:widths: 20,50,15,15

.. csv-table:: Loads tab parameters
:file: ../../tables/loads.csv
:header-rows: 1
:widths: 20,50,15,15

.. csv-table:: Zone-Information tab parameters
:file: ../../tables/zoneinfo_constructions.csv
:header-rows: 1
:widths: auto

.. csv-table:: Conditioning tab parameters
:file: ../../tables/conditioning.csv
:header-rows: 1
:widths: 20,50,15,15
:name: conditioning

.. csv-table:: Ventilation tab parameters
:file: ../../tables/ventilation.csv
:header-rows: 1
:widths: 20,50,15,15

.. csv-table:: Domestic Hot Water tab parameters
:file: ../../tables/dhw.csv
:header-rows: 1
:widths: 20,50,15,15

.. csv-table:: Windows tab parameters
:file: ../../tables/windows.csv
:header-rows: 1
:widths: 20,50,15,15

.. toctree::
:hidden:

Expand Down
53 changes: 6 additions & 47 deletions docs/template-info/Zone-Information/conditioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,12 @@
Conditioning
============

+-------------------------------+-------------+
| Setting | Description |
+===============================+=============+
| :ref:`cond_heating` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_setpoint` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_schedule` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_limit_type` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_max_cap` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_max_flow` | Description |
+-------------------------------+-------------+
| :ref:`cond_h_cop` | Description |
+-------------------------------+-------------+
| :ref:`cond_cooling` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_setpoint` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_schedule` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_limit_type` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_max_cap` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_max_flow` | Description |
+-------------------------------+-------------+
| :ref:`cond_c_cop` | Description |
+-------------------------------+-------------+
| :ref:`cond_mech_vent` | Description |
+-------------------------------+-------------+
| :ref:`cond_mv_schedule` | Description |
+-------------------------------+-------------+
| :ref:`cond_min_freshair_area` | Description |
+-------------------------------+-------------+
| :ref:`cond_min_freshair_pers` | Description |
+-------------------------------+-------------+
| :ref:`cond_econ_type` | Description |
+-------------------------------+-------------+
| :ref:`cond_hr_type` | Description |
+-------------------------------+-------------+
| :ref:`cond_hr_eff_latent` | Description |
+-------------------------------+-------------+
| :ref:`cond_hr_eff_sensible` | Description |
+-------------------------------+-------------+
.. csv-table::
:file: ../../tables/conditioning.csv
:header-rows: 1
:widths: 20,50,15,15
:name: conditioning


.. index:: Heating
.. _cond_heating:
Expand Down
47 changes: 34 additions & 13 deletions docs/template-info/Zone-Information/dhw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,37 @@
Domestic Hot Water
==================

+--------------------+-------------+
| Setting | Description |
+====================+=============+
| Enabled | Description |
+--------------------+-------------+
| Schedule | Description |
+--------------------+-------------+
| Supply temperature | Description |
+--------------------+-------------+
| Inlet temperature | Description |
+--------------------+-------------+
| Flow rate | Description |
+--------------------+-------------+
.. csv-table::
:file: ../../tables/dhw.csv
:header-rows: 1
:widths: 20,50,15,15

.. index:: Enabled
.. _dhw_enabled:

Enabled
```````

.. index:: Scheduled
.. _dhw_scheduled:

Scheduled
`````````

.. index:: Supply Temperature
.. _dhw_setpoint:

Supply Temperature
``````````````````

.. index:: Inlet Temperature
.. _dhw_inlet_temp:

Inlet Temperature
`````````````````

.. index:: Flow rate
.. _dhw_flowrate:

Flow rate
`````````
83 changes: 58 additions & 25 deletions docs/template-info/Zone-Information/loads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,73 @@
Loads
=====

+---------------------------------+-------------+
| Setting | Description |
+=================================+=============+
| People | Description |
+---------------------------------+-------------+
| Occupancy density | Description |
+---------------------------------+-------------+
| Occupancy schedule | Description |
+---------------------------------+-------------+
| Equipment | Description |
+---------------------------------+-------------+
| Equipment power density | Description |
+---------------------------------+-------------+
| Equipment availability schedule | Description |
+---------------------------------+-------------+
| Lighting | Description |
+---------------------------------+-------------+
| Lighting power density | Description |
+---------------------------------+-------------+
| Lighting availability schedule | Description |
+---------------------------------+-------------+
| Dimming type | Description |
+---------------------------------+-------------+
| Illuminance target | Description |
+---------------------------------+-------------+
.. csv-table::
:file: ../../tables/loads.csv
:header-rows: 1
:widths: 20,50,15,15

.. index:: People
.. _loads_people:

People
``````

.. index:: Occupancy density
.. _loads_occ_density:

Occupancy density
`````````````````

.. index:: Occupancy schedule
.. _loads_occ_schedule:

Occupancy schedule
``````````````````

.. index:: Equipment
.. _loads_equipment:

Equipment
`````````

.. index:: Equipment power density
.. _loads_equipment_density:

Equipment power density
```````````````````````

.. index:: Equipment availability schedule
.. _loads_equipement_schedule:

Equipment availability schedule
```````````````````````````````

.. index:: Lighting
.. _loads_lighting:

Lighting
````````

.. index:: Lighting power density
.. _loads_lighting_density:

Lighting power density
``````````````````````

.. index:: Lighting availability schedule
.. _loads_lighting_schedule:

Lighting availability schedule
``````````````````````````````

.. index:: Dimming type
.. _loads_dim_type:

Dimming type
````````````

.. index:: Illuminance target
.. _loads_ill_target:

Illuminance target
``````````````````

0 comments on commit f2bc2c6

Please sign in to comment.