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 
22
23
24
25
26
27
28
29
30
31
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.

Returns:

Type Description

A new WholeBldgUse instance.
Source code in comcheck_api/defaults.py 
34
35
36
37
38
39
40
41
42
43
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.

    Returns:
        A new ``WholeBldgUse`` instance.
    """
    return copy.deepcopy(DEFAULT_BUILDING_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 
46
47
48
49
50
51
52
53
54
55
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 
58
59
60
61
62
63
64
65
66
67
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 
70
71
72
73
74
75
76
77
78
79
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 
82
83
84
85
86
87
88
89
90
91
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 
 94
 95
 96
 97
 98
 99
100
101
102
103
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 
106
107
108
109
110
111
112
113
114
115
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 
118
119
120
121
122
123
124
125
126
127
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 
130
131
132
133
134
135
136
137
138
139
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_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 
142
143
144
145
146
147
148
149
150
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")