energy_system_modelling_wor.../helpers/constants.py

"""
Constant module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2022 Concordia CERC group
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
"""

# universal constants
import sys

KELVIN = 273.15

# converters
HOUR_TO_MINUTES = 60
MINUTES_TO_SECONDS = 60
METERS_TO_FEET = 3.28084
BTU_H_TO_WATTS = 0.29307107
KILO_WATTS_HOUR_TO_JULES = 3600000

# time
SECOND = 'second'
MINUTE = 'minute'
HOUR = 'hour'
DAY = 'day'
WEEK = 'week'
MONTH = 'month'
YEAR = 'year'

# day types
MONDAY = 'monday'
TUESDAY = 'tuesday'
WEDNESDAY = 'wednesday'
THURSDAY = 'thursday'
FRIDAY = 'friday'
SATURDAY = 'saturday'
SUNDAY = 'sunday'
HOLIDAY = 'holiday'
WINTER_DESIGN_DAY = 'winter_design_day'
SUMMER_DESIGN_DAY = 'summer_design_day'
WEEK_DAYS = 'Weekdays'
WEEK_ENDS = 'Weekends'
ALL_DAYS = 'Alldays'

# data types
ANY_NUMBER = 'any_number'
FRACTION = 'fraction'
ON_OFF = 'on_off'
TEMPERATURE = 'temperature'
HUMIDITY = 'humidity'
CONTROL_TYPE = 'control_type'
CONTINUOUS = 'continuous'
DISCRETE = 'discrete'
CONSTANT = 'constant'
INTERNAL_GAINS = 'internal_gains'

# surface types
WALL = 'Wall'
GROUND_WALL = 'Ground wall'
GROUND = 'Ground'
ATTIC_FLOOR = 'Attic floor'
ROOF = 'Roof'
INTERIOR_SLAB = 'Interior slab'
INTERIOR_WALL = 'Interior wall'
VIRTUAL_INTERNAL = 'Virtual internal'
WINDOW = 'Window'
DOOR = 'Door'
SKYLIGHT = 'Skylight'

# functions and usages
SINGLE_FAMILY_HOUSE = 'single family house'
MULTI_FAMILY_HOUSE = 'multifamily house'
ROW_HOSE = 'row house'
MID_RISE_APARTMENT = 'mid rise apartment'
HIGH_RISE_APARTMENT = 'high rise apartment'
SMALL_OFFICE = 'small office'
MEDIUM_OFFICE = 'medium office'
LARGE_OFFICE = 'large office'
PRIMARY_SCHOOL = 'primary school'
SECONDARY_SCHOOL = 'secondary school'
STAND_ALONE_RETAIL = 'stand alone retail'
HOSPITAL = 'hospital'
OUT_PATIENT_HEALTH_CARE = 'out-patient health care'
STRIP_MALL = 'strip mall'
SUPERMARKET = 'supermarket'
WAREHOUSE = 'warehouse'
QUICK_SERVICE_RESTAURANT = 'quick service restaurant'
FULL_SERVICE_RESTAURANT = 'full service restaurant'
SMALL_HOTEL = 'small hotel'
LARGE_HOTEL = 'large hotel'
RESIDENTIAL = 'residential'
EDUCATION = 'education'
SCHOOL_WITHOUT_SHOWER = 'school without shower'
SCHOOL_WITH_SHOWER = 'school with shower'
RETAIL_SHOP_WITHOUT_REFRIGERATED_FOOD = 'retail shop without refrigerated food'
RETAIL_SHOP_WITH_REFRIGERATED_FOOD = 'retail shop with refrigerated food'
HOTEL = 'hotel'
HOTEL_MEDIUM_CLASS = 'hotel medium class'
DORMITORY = 'dormitory'
INDUSTRY = 'industry'
RESTAURANT = 'restaurant'
HEALTH_CARE = 'health care'
RETIREMENT_HOME_OR_ORPHANAGE = 'retirement home or orphanage'
OFFICE_AND_ADMINISTRATION = 'office and administration'
EVENT_LOCATION = 'event location'
HALL = 'hall'
SPORTS_LOCATION = 'sports location'
LABOR = 'labor'
GREEN_HOUSE = 'green house'
NON_HEATED = 'non-heated'

LIGHTING = 'Lights'
OCCUPANCY = 'Occupancy'
APPLIANCES = 'Appliances'
HVAC_AVAILABILITY = 'HVAC Avail'
INFILTRATION = 'Infiltration'
COOLING_SET_POINT = 'ClgSetPt'
HEATING_SET_POINT = 'HtgSetPt'
EQUIPMENT = 'Equipment'
ACTIVITY = 'Activity'
PEOPLE_ACTIVITY_LEVEL = 'People Activity Level'

# Geometry
EPSILON = 0.0000001

# HVAC types
ONLY_HEATING = 'Heating'
ONLY_COOLING = 'Colling'
ONLY_VENTILATION = 'Ventilation'
HEATING_AND_VENTILATION = 'Heating and ventilation'
COOLING_AND_VENTILATION = 'Cooling and ventilation'
HEATING_AND_COLLING = 'Heating and cooling'
FULL_HVAC = 'Heating and cooling and ventilation'

# Floats
MAX_FLOAT = float('inf')
MIN_FLOAT = float('-inf')
Quality improvements 2021-08-26 13:27:43 -04:00			`"""`
			`Constant module`
			`SPDX - License - Identifier: LGPL - 3.0 - or -later`
License header change to better reflect the coder and code contributors, remove the Model creators from the contributors as it may be misleading 2022-04-08 09:35:33 -04:00			`Copyright © 2022 Concordia CERC group`
			`Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca`
Quality improvements 2021-08-26 13:27:43 -04:00			`"""`

erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`# universal constants`
completed parser for the data sources 2022-05-19 12:02:13 -04:00			`import sys`

added 'year' to 'minute' as constants in constants.py and adapted the code to that 2021-05-25 13:34:57 -04:00			`KELVIN = 273.15`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00
created customized imports factory and correspondent test 2021-11-05 10:16:35 -04:00			`# converters`
			`HOUR_TO_MINUTES = 60`
completed parser for the data sources 2022-05-19 12:02:13 -04:00			`MINUTES_TO_SECONDS = 60`
created customized imports factory and correspondent test 2021-11-05 10:16:35 -04:00			`METERS_TO_FEET = 3.28084`
Added comnet usage library, including import factory. Some modifications on internal_gains.py and hft_internal_gains_archetypes.py were required. Also created a class to pass from daily schedules to yearly schedule. 2021-11-11 17:25:53 -05:00			`BTU_H_TO_WATTS = 0.29307107`
complete modification of the structure of the classes that define the buildig for a better adjustment to the different data sources and the connected tools. NOT finished 2022-03-17 18:49:44 -04:00			`KILO_WATTS_HOUR_TO_JULES = 3600000`
created customized imports factory and correspondent test 2021-11-05 10:16:35 -04:00
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`# time`
added Schedule class. Modified schedules attribute in usage_zone.py according to this new class. Modified comnet import and its test. Other imports and exports related to schedules will be broken. 2021-09-01 12:14:48 -04:00			`SECOND = 'second'`
added 'year' to 'minute' as constants in constants.py and adapted the code to that 2021-05-25 13:34:57 -04:00			`MINUTE = 'minute'`
			`HOUR = 'hour'`
			`DAY = 'day'`
			`WEEK = 'week'`
			`MONTH = 'month'`
			`YEAR = 'year'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00
added Schedule class. Modified schedules attribute in usage_zone.py according to this new class. Modified comnet import and its test. Other imports and exports related to schedules will be broken. 2021-09-01 12:14:48 -04:00			`# day types`
			`MONDAY = 'monday'`
			`TUESDAY = 'tuesday'`
			`WEDNESDAY = 'wednesday'`
			`THURSDAY = 'thursday'`
			`FRIDAY = 'friday'`
			`SATURDAY = 'saturday'`
			`SUNDAY = 'sunday'`
			`HOLIDAY = 'holiday'`
			`WINTER_DESIGN_DAY = 'winter_design_day'`
			`SUMMER_DESIGN_DAY = 'summer_design_day'`
modified doe_idf.py to save on new schedule format 2022-02-17 12:37:14 -05:00			`WEEK_DAYS = 'Weekdays'`
			`WEEK_ENDS = 'Weekends'`
			`ALL_DAYS = 'Alldays'`
added Schedule class. Modified schedules attribute in usage_zone.py according to this new class. Modified comnet import and its test. Other imports and exports related to schedules will be broken. 2021-09-01 12:14:48 -04:00
			`# data types`
			`ANY_NUMBER = 'any_number'`
			`FRACTION = 'fraction'`
			`ON_OFF = 'on_off'`
			`TEMPERATURE = 'temperature'`
			`HUMIDITY = 'humidity'`
			`CONTROL_TYPE = 'control_type'`
modifications in idf to import more complex schedules and schedules by file 2022-04-26 18:39:42 -04:00			`CONTINUOUS = 'continuous'`
			`DISCRETE = 'discrete'`
			`CONSTANT = 'constant'`
erased not_detailed_source_mean_annual_internal_gains parameter and changed by internal_gains. During the import, for those catalogs that don't provide that information, the internal_gains are calculated and saved depending on the information they provide. 2022-05-18 14:52:41 -04:00			`INTERNAL_GAINS = 'internal_gains'`
added Schedule class. Modified schedules attribute in usage_zone.py according to this new class. Modified comnet import and its test. Other imports and exports related to schedules will be broken. 2021-09-01 12:14:48 -04:00
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`# surface types`
			`WALL = 'Wall'`
			`GROUND_WALL = 'Ground wall'`
			`GROUND = 'Ground'`
			`ATTIC_FLOOR = 'Attic floor'`
			`ROOF = 'Roof'`
			`INTERIOR_SLAB = 'Interior slab'`
			`INTERIOR_WALL = 'Interior wall'`
modified structure to new concept (thermal zones created after building division). Thermal_zone still not created, all tests related to thermal zones don't pass. 2021-06-23 09:53:33 -04:00			`VIRTUAL_INTERNAL = 'Virtual internal'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`WINDOW = 'Window'`
			`DOOR = 'Door'`
			`SKYLIGHT = 'Skylight'`

Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`# functions and usages`
			`SINGLE_FAMILY_HOUSE = 'single family house'`
			`MULTI_FAMILY_HOUSE = 'multifamily house'`
			`ROW_HOSE = 'row house'`
			`MID_RISE_APARTMENT = 'mid rise apartment'`
			`HIGH_RISE_APARTMENT = 'high rise apartment'`
			`SMALL_OFFICE = 'small office'`
			`MEDIUM_OFFICE = 'medium office'`
			`LARGE_OFFICE = 'large office'`
			`PRIMARY_SCHOOL = 'primary school'`
			`SECONDARY_SCHOOL = 'secondary school'`
			`STAND_ALONE_RETAIL = 'stand alone retail'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`HOSPITAL = 'hospital'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`OUT_PATIENT_HEALTH_CARE = 'out-patient health care'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`STRIP_MALL = 'strip mall'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`SUPERMARKET = 'supermarket'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`WAREHOUSE = 'warehouse'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`QUICK_SERVICE_RESTAURANT = 'quick service restaurant'`
			`FULL_SERVICE_RESTAURANT = 'full service restaurant'`
			`SMALL_HOTEL = 'small hotel'`
			`LARGE_HOTEL = 'large hotel'`
			`RESIDENTIAL = 'residential'`
			`EDUCATION = 'education'`
			`SCHOOL_WITHOUT_SHOWER = 'school without shower'`
			`SCHOOL_WITH_SHOWER = 'school with shower'`
			`RETAIL_SHOP_WITHOUT_REFRIGERATED_FOOD = 'retail shop without refrigerated food'`
			`RETAIL_SHOP_WITH_REFRIGERATED_FOOD = 'retail shop with refrigerated food'`
			`HOTEL = 'hotel'`
			`HOTEL_MEDIUM_CLASS = 'hotel medium class'`
			`DORMITORY = 'dormitory'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`INDUSTRY = 'industry'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`RESTAURANT = 'restaurant'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`HEALTH_CARE = 'health care'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`RETIREMENT_HOME_OR_ORPHANAGE = 'retirement home or orphanage'`
			`OFFICE_AND_ADMINISTRATION = 'office and administration'`
			`EVENT_LOCATION = 'event location'`
erased populate and created enrich in libs.helpers. add new constants to helpers.constants 2021-06-10 10:48:30 -04:00			`HALL = 'hall'`
Major changes with two objectives: homogenize the usage parameters regardless the data source, and completely uncouple geometry and construction library (before the geometry was modified after reading storey high from construction library), and construction and usage libraries (before the usage library could only be read after construction library, now ant order is accepted). 2022-03-24 16:51:01 -04:00			`SPORTS_LOCATION = 'sports location'`
			`LABOR = 'labor'`
			`GREEN_HOUSE = 'green house'`
			`NON_HEATED = 'non-heated'`
Added comnet usage library, including import factory. Some modifications on internal_gains.py and hft_internal_gains_archetypes.py were required. Also created a class to pass from daily schedules to yearly schedule. 2021-11-11 17:25:53 -05:00
			`LIGHTING = 'Lights'`
			`OCCUPANCY = 'Occupancy'`
fixed bug saving values 2022-03-08 19:19:52 -05:00			`APPLIANCES = 'Appliances'`
Added comnet usage library, including import factory. Some modifications on internal_gains.py and hft_internal_gains_archetypes.py were required. Also created a class to pass from daily schedules to yearly schedule. 2021-11-11 17:25:53 -05:00			`HVAC_AVAILABILITY = 'HVAC Avail'`
			`INFILTRATION = 'Infiltration'`
			`COOLING_SET_POINT = 'ClgSetPt'`
			`HEATING_SET_POINT = 'HtgSetPt'`
modified doe_idf.py to save on new schedule format 2022-02-17 12:37:14 -05:00			`EQUIPMENT = 'Equipment'`
			`ACTIVITY = 'Activity'`
Found a bug in comnet factory and modified type of data from temperature to any number 2022-06-06 13:37:48 -04:00			`PEOPLE_ACTIVITY_LEVEL = 'People Activity Level'`
fixed bug saving values 2022-03-08 19:19:52 -05:00
			`# Geometry`
			`EPSILON = 0.0000001`

			`# HVAC types`
			`ONLY_HEATING = 'Heating'`
			`ONLY_COOLING = 'Colling'`
			`ONLY_VENTILATION = 'Ventilation'`
			`HEATING_AND_VENTILATION = 'Heating and ventilation'`
			`COOLING_AND_VENTILATION = 'Cooling and ventilation'`
			`HEATING_AND_COLLING = 'Heating and cooling'`
			`FULL_HVAC = 'Heating and cooling and ventilation'`
completed parser for the data sources 2022-05-19 12:02:13 -04:00
			`# Floats`
			`MAX_FLOAT = float('inf')`
			`MIN_FLOAT = float('-inf')`