hub/catalog_factories/usage/usage_helper.py

"""
Usage helper
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2022 Concordia CERC group
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
"""
import sys
import helpers.constants as cte
from typing import Dict


class UsageHelper:
  """
  Usage helper class
  """
  _nrcan_schedule_type_to_hub_schedule_type = {
    'Lighting': cte.LIGHTING,
    'Occupancy': cte.OCCUPANCY,
    'Equipment': cte.APPLIANCES,
    'Thermostat Setpoint Cooling': cte.COOLING_SET_POINT,  # Compose 'Thermostat Setpoint' + 'Cooling'
    'Thermostat Setpoint Heating': cte.HEATING_SET_POINT,  # Compose 'Thermostat Setpoint' + 'Heating'
  }
  _nrcan_data_type_to_hub_data_type = {
    'FRACTION': cte.FRACTION,
    'ON_OFF': cte.ON_OFF,
    'TEMPERATURE': cte.ANY_NUMBER
  }

  _nrcan_time_to_hub_time = {
    'Hourly': cte.HOUR,
    'Constant': cte.CONSTANT
  }

  _nrcan_day_type_to_hub_days = {
    'Default|Wkdy': [cte.MONDAY, cte.TUESDAY, cte.WEDNESDAY, cte.THURSDAY, cte.FRIDAY],
    'Sun|Hol': [cte.SUNDAY, cte.HOLIDAY],
    'Sat': [cte.SATURDAY],
    'Default|WntrDsn|SmrDsn': [cte.MONDAY,
                               cte.TUESDAY,
                               cte.WEDNESDAY,
                               cte.THURSDAY,
                               cte.FRIDAY,
                               cte.SATURDAY,
                               cte.SUNDAY,
                               cte.HOLIDAY,
                               cte.WINTER_DESIGN_DAY,
                               cte.SUMMER_DESIGN_DAY],
    'Default': [cte.MONDAY,
                cte.TUESDAY,
                cte.WEDNESDAY,
                cte.THURSDAY,
                cte.FRIDAY,
                cte.SATURDAY,
                cte.SUNDAY,
                cte.HOLIDAY,
                cte.WINTER_DESIGN_DAY,
                cte.SUMMER_DESIGN_DAY]

  }

  _usage_to_hft = {
    cte.RESIDENTIAL: 'residential',
    cte.SINGLE_FAMILY_HOUSE: 'Single family house',
    cte.MULTI_FAMILY_HOUSE: 'Multi-family house',
    cte.EDUCATION: 'education',
    cte.SCHOOL_WITHOUT_SHOWER: 'school without shower',
    cte.SCHOOL_WITH_SHOWER: 'school with shower',
    cte.RETAIL_SHOP_WITHOUT_REFRIGERATED_FOOD: 'retail',
    cte.RETAIL_SHOP_WITH_REFRIGERATED_FOOD: 'retail shop / refrigerated food',
    cte.HOTEL: 'hotel',
    cte.HOTEL_MEDIUM_CLASS: 'hotel (Medium-class)',
    cte.DORMITORY: 'dormitory',
    cte.INDUSTRY: 'industry',
    cte.RESTAURANT: 'restaurant',
    cte.HEALTH_CARE: 'health care',
    cte.RETIREMENT_HOME_OR_ORPHANAGE: 'Home for the aged or orphanage',
    cte.OFFICE_AND_ADMINISTRATION: 'office and administration',
    cte.EVENT_LOCATION: 'event location',
    cte.HALL: 'hall',
    cte.SPORTS_LOCATION: 'sport location',
    cte.LABOR: 'Labor',
    cte.GREEN_HOUSE: 'green house',
    cte.NON_HEATED: 'non-heated'
  }

  _comnet_days = [cte.MONDAY,
                  cte.TUESDAY,
                  cte.WEDNESDAY,
                  cte.THURSDAY,
                  cte.FRIDAY,
                  cte.SATURDAY,
                  cte.SUNDAY,
                  cte.HOLIDAY]

  _usage_to_comnet = {
    cte.RESIDENTIAL: 'BA Multifamily',
    cte.SINGLE_FAMILY_HOUSE: 'BA Multifamily',
    cte.MULTI_FAMILY_HOUSE: 'BA Multifamily',
    cte.EDUCATION: 'BA School/University',
    cte.SCHOOL_WITHOUT_SHOWER: 'BA School/University',
    cte.SCHOOL_WITH_SHOWER: 'BA School/University',
    cte.RETAIL_SHOP_WITHOUT_REFRIGERATED_FOOD: 'BA Retail',
    cte.RETAIL_SHOP_WITH_REFRIGERATED_FOOD: 'BA Retail',
    cte.HOTEL: 'BA Hotel',
    cte.HOTEL_MEDIUM_CLASS: 'BA Hotel',
    cte.DORMITORY: 'BA Dormitory',
    cte.INDUSTRY: 'BA Manufacturing Facility',
    cte.RESTAURANT: 'BA Dining: Family',
    cte.HEALTH_CARE: 'BA Hospital',
    cte.RETIREMENT_HOME_OR_ORPHANAGE: 'BA Multifamily',
    cte.OFFICE_AND_ADMINISTRATION: 'BA Office',
    cte.EVENT_LOCATION: 'BA Convention Center',
    cte.HALL: 'BA Convention Center',
    cte.SPORTS_LOCATION: 'BA Sports Arena',
    cte.LABOR: 'BA Gymnasium',
    cte.GREEN_HOUSE: cte.GREEN_HOUSE,
    cte.NON_HEATED: cte.NON_HEATED
  }

  _comnet_data_type_to_hub_data_type = {
    'Fraction': cte.FRACTION,
    'OnOff': cte.ON_OFF,
    'Temperature': cte.ANY_NUMBER
  }

  _comnet_schedules_key_to_comnet_schedules = {
    'C-1 Assembly': 'C-1 Assembly',
    'C-2 Public': 'C-2 Health',
    'C-3 Hotel Motel': 'C-3 Hotel',
    'C-4 Manufacturing': 'C-4 Manufacturing',
    'C-5 Office': 'C-5 Office',
    'C-7 Restaurant': 'C-7 Restaurant',
    'C-8 Retail': 'C-8 Retail',
    'C-9 Schools': 'C-9 School',
    'C-10 Warehouse': 'C-10 Warehouse',
    'C-11 Laboratory': 'C-11 Lab',
    'C-12 Residential': 'C-12 Residential',
    'C-14 Gymnasium': 'C-14 Gymnasium'
  }

  @property
  def nrcan_day_type_to_hub_days(self):
    return self._nrcan_day_type_to_hub_days

  @property
  def nrcan_schedule_type_to_hub_schedule_type(self):
    return self._nrcan_schedule_type_to_hub_schedule_type

  @property
  def nrcan_data_type_to_hub_data_type(self):
    return self._nrcan_data_type_to_hub_data_type

  @property
  def nrcan_time_to_hub_time(self):
    return self._nrcan_time_to_hub_time

  @property
  def comnet_data_type_to_hub_data_type(self):
    return self._comnet_data_type_to_hub_data_type

  @property
  def comnet_schedules_key_to_comnet_schedules(self) -> Dict:
    return self._comnet_schedules_key_to_comnet_schedules

  @property
  def comnet_days(self):
    return self._comnet_days

  @staticmethod
  def comnet_from_hub_usage(usage):
    """
    Get Comnet usage from the given internal usage key
    :param usage: str
    :return: str
    """
    try:
      return UsageHelper._usage_to_comnet[usage]
    except KeyError:
      sys.stderr.write('Error: keyword not found to translate from hub_usage to comnet usage.\n')

  @staticmethod
  def schedules_key(usage):
    """
    Get Comnet schedules key from the list found in the Comnet usage file
    :param usage: str
    :return: str
    """
    try:
      return UsageHelper._comnet_schedules_key_to_comnet_schedules[usage]
    except KeyError:
      sys.stderr.write('Error: Comnet keyword not found. An update of the Comnet files might have been '
                       'done changing the keywords.\n')

  @staticmethod
  def hft_from_hub_usage(usage):
    """
    Get HfT usage from the given internal usage key
    :param usage: str
    :return: str
    """
    try:
      return UsageHelper._usage_to_hft[usage]
    except KeyError:
      sys.stderr.write('Error: keyword not found to translate from hub_usage to hft usage.\n')