uwg.schdef module¶

Class for Schedule Definition.

class uwg.schdef.SchDef(elec, gas, light, occ, cool, heat, q_elec, q_gas, q_light, n_occ, vent, bldtype, builtera, swh=[[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]], v_swh=0)[source]¶

Bases: object

Schedule definition class.

The internal load weekly schedules consists of three lists of 24 values representing hours in weekday, Saturday, and Sunday.

Parameters:

elec – Weekly schedule of fractional electricity plug process loads.
gas – Weekly schedule of fractional gas process loads.
light – Weekly schedule of fractional light process loads.
occ – Weekly schedule of fractional occupant number.
cool – Weekly schedule of cooling temperatures.
heat – Weekly schedule of heating temperatures.
q_elec – Maximum electrical plug process load [W/m2].
q_gas – Maximum gas process load per unit area [W/m2].
q_light – Maximum light process load per unit area [W/m2].
n_occ – Maximum number of occupants per unit area [person/m2].
vent – Maximum ventilation rate per unit area [m3/s/m2].
swh – Optional property for weekly schedule of fractional hot water rate. This property will be a weekly schedule of zero values, as default.
v_swh – Optional property for maximum volumetric hot water rate per unit area [L/hr/m2]. (Default: 0).
bldtype – Text referring to a building type. By default, 16 building types are defined in the UWG according to models from the Department of Energy (DOE). Custom building types can also be defined with a new name. Note that this value along with the BEMDef builtera must exactly match the identifiers in the UWG bld list in order to specify the fraction of total built stock the building occupies in the UWG simulation. Choose from the following to reference or overwrite a BEM associated with a DOE reference building type: ‘fullservicerestaurant’, ‘hospital’, ‘largehotel’, ‘largeoffice’, ‘mediumoffice’, ‘midriseapartment’, ‘outpatient’, ‘primaryschool’, ‘quickservicerestaurant’, ‘secondaryschool’, ‘smallhotel’, ‘smalloffice’, ‘standaloneretail’, ‘stripmall’, ‘supermarket’, or ‘warehouse’.
builtera – Text defining building built era. Must be one of the following: “pre80” (pre-1980s), “pst80” (post-1980s), or “new” (new construction). This value along with the bldtype must exactly match the identifiers in the bld array in order to specify the fraction of total built stock the building occupies in the UWG simulation.

Properties:

elec
gas
light
occ
cool
heat
swh
q_elec
q_gas
q_light
n_occ
vent
v_swh
bldtype
builtera
zonetype

static check_week_validity(week, name)[source]¶

classmethod from_dict(data)[source]¶

Create a SchDef object from a dictionary.

Parameters:: data – A SchDef dictionary following the format below.

_example_week = [
    [0.2, 0.2, 0.2, 0.2, 0.2, 0.4, 0.7, 0.9, 0.9, 0.6, 0.6, 0.6, 0.6, 0.6,
     0.7, 0.8, 0.9, 0.9, 0.8, 0.8, 0.7, 0.3, 0.2, 0.2],  # Weekday
    [0.2, 0.2, 0.2, 0.2, 0.2, 0.3, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5, 0.5,
     0.6, 0.7, 0.7, 0.7, 0.7, 0.5, 0.4, 0.3, 0.2, 0.2],  # Saturday
    [0.2, 0.2, 0.2, 0.2, 0.2, 0.3, 0.4, 0.4, 0.4, 0.4, 0.4, 0.4, 0.4, 0.4,
     0.4, 0.4, 0.4, 0.4, 0.4, 0.4, 0.3, 0.3, 0.2, 0.2]]  # Sunday

{
"elec": _example_week,
"gas": _example_week,
"light": _example_week,
"occ": _example_week,
"cool": _example_week,
"heat": _example_week,
"swh": _example_week,
"q_elec" = q_elec,
"q_gas" = q_gas,
"q_light" = q_light,
"n_occ" = n_occ,
"vent" = vent,
"v_swh" = v_swh,
"bldtype": 0,
"builtera": 1
}

to_dict()[source]¶: SchDef dictionary representation.

DEFAULT_SWH = [[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]]¶

property bldtype¶

Get or set text for building type.

By default, 16 building types are defined in the UWG according to models from the Department of Energy (DOE). Choose from the following to reference or overwrite a schedule associated with a DOE reference building type:

‘fullservicerestaurant’
‘hospital’
‘largehotel’
‘largeoffice’
‘medoffice’
‘midriseapartment’
‘outpatient’
‘primaryschool’
‘quickservicerestaurant’
‘secondaryschool’
‘smallhotel’
‘smalloffice’
‘standaloneretail’
‘stripmall’
‘supermarket’
‘warehouse’

Custom building types can also be defined with a new name. If a custom SchDef is defined with the same name as a reference DOE building type from the list above, the reference SchDef will be overwritten by the custom SchDef. Note that this value along with the SchDef builtera must exactly match the identifiers in the UWG bld list in order to specify the fraction of total built stock the building occupies in the UWG simulation.

property builtera¶

Get or set text for built era.

Must be one of the following:

‘pre80’ - pre-1980s
‘pst80’ - post-1980s
‘new’ - new construction

This value along with the bldtype must exactly match the identifiers in the bld array in order to specify the fraction of total built stock the building occupies in the UWG simulation.

property cool¶

Get or set weekly schedule of cooling temperatures.