Skip to content

Project Defaults

Functions that return deep copies of pre-configured default templates for projects and building components.

defaults

Module for project default templates/values.

get_default_project_template 

get_default_project_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.ComBuilding template.

The template is pre-populated with sensible defaults for location (Boulder, CO), envelope, lighting, HVAC, and other required sections.

Returns:

Type Description

A new ComBuilding instance ready to be customized.
Source code in comcheck_api/defaults.py 
30
31
32
33
34
35
36
37
38
39
def get_default_project_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.ComBuilding` template.

    The template is pre-populated with sensible defaults for location
    (Boulder, CO), envelope, lighting, HVAC, and other required sections.

    Returns:
        A new ``ComBuilding`` instance ready to be customized.
    """
    return copy.deepcopy(PROJECT_TEMPLATE)

get_default_building_area_template 

get_default_building_area_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.WholeBldgUse template.

Defaults to an Automotive Facility with 1 000 sq ft floor area and interior lighting space initialized. Each call gets a fresh unique key and a unique areaDescription (UUID suffix appended) so multiple areas can be added to a project without colliding on either field.

Returns:

Type Description

A new WholeBldgUse instance.
Source code in comcheck_api/defaults.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def get_default_building_area_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.WholeBldgUse` template.

    Defaults to an *Automotive Facility* with 1 000 sq ft floor area and
    interior lighting space initialized.  Each call gets a fresh unique ``key``
    and a unique ``areaDescription`` (UUID suffix appended) so multiple areas
    can be added to a project without colliding on either field.

    Returns:
        A new ``WholeBldgUse`` instance.
    """
    area = copy.deepcopy(DEFAULT_BUILDING_AREA)
    uid = str(uuid4())
    area.key = uid
    area.areaDescription = f"{DEFAULT_BUILDING_AREA.areaDescription} {uid[:8]}"
    return area

get_default_roof_template 

get_default_roof_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Roof template.

Defaults to an above-deck roof with 6 000 sq ft gross area and R-37 continuous insulation.

Returns:

Type Description

A new Roof instance.
Source code in comcheck_api/defaults.py 
60
61
62
63
64
65
66
67
68
69
def get_default_roof_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Roof` template.

    Defaults to an above-deck roof with 6 000 sq ft gross area and
    R-37 continuous insulation.

    Returns:
        A new ``Roof`` instance.
    """
    return copy.deepcopy(DEFAULT_ROOF)

get_default_ag_wall_template 

get_default_ag_wall_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.AgWall template.

Defaults to a metal-frame 24-inch above-grade wall with 4 800 sq ft gross area, R-20 cavity / R-10 continuous insulation.

Returns:

Type Description

A new AgWall instance.
Source code in comcheck_api/defaults.py 
72
73
74
75
76
77
78
79
80
81
def get_default_ag_wall_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.AgWall` template.

    Defaults to a metal-frame 24-inch above-grade wall with 4 800 sq ft
    gross area, R-20 cavity / R-10 continuous insulation.

    Returns:
        A new ``AgWall`` instance.
    """
    return copy.deepcopy(DEFAULT_AG_WALL)

get_default_floor_template 

get_default_floor_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Floor template.

Defaults to a heated slab-on-grade floor with 320 sq ft gross area and R-15 continuous insulation.

Returns:

Type Description

A new Floor instance.
Source code in comcheck_api/defaults.py 
84
85
86
87
88
89
90
91
92
93
def get_default_floor_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Floor` template.

    Defaults to a heated slab-on-grade floor with 320 sq ft gross area
    and R-15 continuous insulation.

    Returns:
        A new ``Floor`` instance.
    """
    return copy.deepcopy(DEFAULT_FLOOR)

get_default_bg_wall_template 

get_default_bg_wall_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.BgWall template.

Defaults to a concrete below-grade wall with 3 000 sq ft gross area, R-20 cavity / R-10 continuous insulation, and wood furring.

Returns:

Type Description

A new BgWall instance.
Source code in comcheck_api/defaults.py 
 96
 97
 98
 99
100
101
102
103
104
105
def get_default_bg_wall_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.BgWall` template.

    Defaults to a concrete below-grade wall with 3 000 sq ft gross area,
    R-20 cavity / R-10 continuous insulation, and wood furring.

    Returns:
        A new ``BgWall`` instance.
    """
    return copy.deepcopy(DEFAULT_BG_WALL)

get_default_skylight_template 

get_default_skylight_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Skylight template.

Defaults to a no-curb, double-pane low-E skylight with 100 sq ft gross area.

Returns:

Type Description

A new Skylight instance.
Source code in comcheck_api/defaults.py 
108
109
110
111
112
113
114
115
116
117
def get_default_skylight_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Skylight` template.

    Defaults to a no-curb, double-pane low-E skylight with 100 sq ft
    gross area.

    Returns:
        A new ``Skylight`` instance.
    """
    return copy.deepcopy(DEFAULT_SKYLIGHT)

get_default_window_template 

get_default_window_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Window template.

Defaults to a triple-pane, non-operable, metal-frame window with 300 sq ft gross area and NFRC performance data.

Returns:

Type Description

A new Window instance.
Source code in comcheck_api/defaults.py 
120
121
122
123
124
125
126
127
128
129
def get_default_window_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Window` template.

    Defaults to a triple-pane, non-operable, metal-frame window with
    300 sq ft gross area and NFRC performance data.

    Returns:
        A new ``Window`` instance.
    """
    return copy.deepcopy(DEFAULT_WINDOW)

get_default_door_template 

get_default_door_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Door template.

Defaults to a swinging, insulated metal entrance door with 23 sq ft gross area.

Returns:

Type Description

A new Door instance.
Source code in comcheck_api/defaults.py 
132
133
134
135
136
137
138
139
140
141
def get_default_door_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Door` template.

    Defaults to a swinging, insulated metal entrance door with 23 sq ft
    gross area.

    Returns:
        A new ``Door`` instance.
    """
    return copy.deepcopy(DEFAULT_DOOR)

get_default_thermal_bridge_template 

get_default_thermal_bridge_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.ThermalBridge template.

Defaults to a prescriptive linear floor-to-wall intersection thermal bridge with a psi factor of 0.177 and 100 ft length.

Returns:

Type Description

A new ThermalBridge instance.
Source code in comcheck_api/defaults.py 
144
145
146
147
148
149
150
151
152
153
def get_default_thermal_bridge_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.ThermalBridge` template.

    Defaults to a prescriptive linear floor-to-wall intersection thermal
    bridge with a psi factor of 0.177 and 100 ft length.

    Returns:
        A new ``ThermalBridge`` instance.
    """
    return copy.deepcopy(DEFAULT_THERMAL_BRIDGE)

get_default_interior_space_template 

get_default_interior_space_template()

Return a deep copy of the default interior lighting space template.

In the COMcheck API schema, an interior lighting space is represented by the :class:~comcheck_api.types.core_types.ActivityUse model, aliased as :class:~comcheck_api.types.common_types.InteriorSpace. This corresponds to what the COMcheck web app calls an Interior Lighting Space.

The key field is set to "__unset__" — pass the template directly to :func:~comcheck_api.project_operations.project_interior_lighting_operations.add_interior_space_to_project, which sets the key to the parent building area automatically.

Returns:

Type Description

A new :class:~comcheck_api.types.common_types.InteriorSpace instance.
Source code in comcheck_api/defaults.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def get_default_interior_space_template():
    """Return a deep copy of the default interior lighting space template.

    In the COMcheck API schema, an interior lighting space is represented by
    the :class:`~comcheck_api.types.core_types.ActivityUse` model, aliased as
    :class:`~comcheck_api.types.common_types.InteriorSpace`.  This corresponds
    to what the COMcheck web app calls an *Interior Lighting Space*.

    The ``key`` field is set to ``"__unset__"`` — pass the template directly to
    :func:`~comcheck_api.project_operations.project_interior_lighting_operations.add_interior_space_to_project`,
    which sets the key to the parent building area automatically.

    Returns:
        A new :class:`~comcheck_api.types.common_types.InteriorSpace` instance.
    """
    return copy.deepcopy(DEFAULT_INTERIOR_SPACE_AREA)

get_default_fixture_template 

get_default_fixture_template()

Return a deep copy of the default :class:~comcheck_api.types.core_types.Fixture template.

Defaults to an LED fixture at 32 W, quantity 1, with no lighting controls.

Returns:

Type Description

A new Fixture instance.
Source code in comcheck_api/defaults.py 
174
175
176
177
178
179
180
181
182
def get_default_fixture_template():
    """Return a deep copy of the default :class:`~comcheck_api.types.core_types.Fixture` template.

    Defaults to an LED fixture at 32 W, quantity 1, with no lighting controls.

    Returns:
        A new ``Fixture`` instance.
    """
    return copy.deepcopy(DEFAULT_FIXTURE)

get_default_exterior_area_template 

get_default_exterior_area_template()

Return a deep copy of the default exterior lighting area template.

In the COMcheck API schema, an exterior lighting area is represented by the :class:~comcheck_api.types.core_types.ExteriorUse model, aliased as :class:~comcheck_api.types.common_types.ExteriorArea. This corresponds to what the COMcheck web app calls an Exterior Lighting Area.

Defaults to a parking-area exterior lighting area with 1 000 sq ft quantity and an empty :class:~comcheck_api.types.core_types.ExteriorLightingSpace.

Returns:

Type Description

A new :class:~comcheck_api.types.common_types.ExteriorArea instance.
Source code in comcheck_api/defaults.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def get_default_exterior_area_template():
    """Return a deep copy of the default exterior lighting area template.

    In the COMcheck API schema, an exterior lighting area is represented by
    the :class:`~comcheck_api.types.core_types.ExteriorUse` model, aliased as
    :class:`~comcheck_api.types.common_types.ExteriorArea`.  This corresponds
    to what the COMcheck web app calls an *Exterior Lighting Area*.

    Defaults to a parking-area exterior lighting area with 1 000 sq ft quantity
    and an empty :class:`~comcheck_api.types.core_types.ExteriorLightingSpace`.

    Returns:
        A new :class:`~comcheck_api.types.common_types.ExteriorArea` instance.
    """
    return copy.deepcopy(DEFAULT_EXTERIOR_AREA)

get_default_fixture_schedule_template 

get_default_fixture_schedule_template()

Return a default fixture schedule template with a unique key.

.. warning:: Not yet implemented — raises :exc:NotImplementedError.

Source code in comcheck_api/defaults.py 
202
203
204
205
206
207
208
209
210
def get_default_fixture_schedule_template():
    """Return a default fixture schedule template with a unique key.

    .. warning::
        Not yet implemented — raises :exc:`NotImplementedError`.
    """
    # TODO: Implement when DEFAULT_FIXTURE_SCHEDULE constant is available
    # return {**DEFAULT_FIXTURE_SCHEDULE, "scheduleFixtureKey": str(uuid4())}
    raise NotImplementedError("DEFAULT_FIXTURE_SCHEDULE constant not yet implemented")