city_retrofit/tests/test_idf.py

"""
TestOccupancyFactory test and validate the city model structure occupancy parameters
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
"""
from pathlib import Path
from unittest import TestCase
from geomeppy import IDF
from geometry.geometry_factory import GeometryFactory
from helpers.idf_helper import IdfHelper


class TestIdf(TestCase):
  """
  Test IDF Class
  """

  def setUp(self) -> None:
    """
    Test setup
    :return: None
    """
    self._city_gml = None
    self._example_path = (Path(__file__).parent.parent / 'tests_data').resolve()

  def _get_citygml(self):
    if self._city_gml is None:
      file_path = (self._example_path / 'buildings.gml').resolve()
      self._city_gml = GeometryFactory('citygml', file_path).city
      self.assertIsNotNone(self._city_gml, 'city is none')
    return self._city_gml

  def test_idf_run(self):
    idd_file_path = (self._example_path / 'energy+.idd').resolve()
    idf_file_path = (self._example_path / 'minimal.idf').resolve()
    epw_file_path = (self._example_path / 'montreal.epw').resolve()
    _idf = IdfHelper(idf_file_path, idd_file_path, epw_file_path, self._example_path)
    city = self._get_citygml()
    for building in city.buildings:
      _idf.add_block(building)

      # _idf.add_surfaces(building)
      # for surface in building.surfaces:
        # _idf.add_surface(surface, building.name)

    _idf.run(output_directory="ep_outputs")
    self.assertTrue(True)

  def test_tutorial_1(self):
    idd_file_path = (self._example_path / 'energy+.idd').resolve()
    idf_file_path = (self._example_path / 'minimal.idf').resolve()
    epw_file_path = (self._example_path / 'montreal.epw').resolve()
    IDF.setiddname(str(idd_file_path), testing=True)
    idf = IDF(str(idf_file_path))
    idf.epw = str(epw_file_path)
    idf.add_block(
        name="Boring hut", coordinates=[(10, 0), (10, 10), (0, 10), (0, 0)], height=3.5
    )
    idf.intersect_match()
    idf.set_wwr(0.6, construction="Project External Window")
    idf.set_default_constructions()
    idf.to_obj("boring_hut.obj")
    idf.run(output_directory="tests")

  def test_tutorial_2(self):
    IDF.setiddname("C:/EnergyPlusV9-1-0/Energy+.idd", testing=True)
    idf = IDF("C:/EnergyPlusV9-1-0/ExampleFiles/Minimal.idf")
    idf.epw = "USA_CO_Golden-NREL.724666_TMY3.epw"
    idf.add_block(
        name="Two storey",
        coordinates=[(10, 0), (10, 5), (0, 5), (0, 0)],
        height=6,
        num_stories=2,
    )
    idf.add_block(
        name="One storey", coordinates=[(10, 5), (10, 10), (0, 10), (0, 5)], height=3
    )
    idf.intersect_match()
    idf.set_default_constructions()
    # add a heating system
    stat = idf.newidfobject(
        "HVACTEMPLATE:THERMOSTAT",
        Name="Zone Stat",
        Constant_Heating_Setpoint=20,
        Constant_Cooling_Setpoint=25,
    )
    for zone in idf.idfobjects["ZONE"]:
        idf.newidfobject(
            "HVACTEMPLATE:ZONE:IDEALLOADSAIRSYSTEM",
            Zone_Name=zone.Name,
            Template_Thermostat_Name=stat.Name,
        )
    # add some output variables
    idf.newidfobject(
        "OUTPUT:VARIABLE",
        Variable_Name="Zone Ideal Loads Supply Air Total Heating Energy",
        Reporting_Frequency="Hourly",
    )
    idf.newidfobject(
        "OUTPUT:VARIABLE",
        Variable_Name="Zone Ideal Loads Supply Air Total Cooling Energy",
        Reporting_Frequency="Hourly",
    )
    # run a set of simulations, moving glazing from mostly on the South facade, to mostly on the North facade
    north_wwr = [i / 10 for i in range(1, 10)]
    south_wwr = [1 - wwr for wwr in north_wwr]
    for north, south in zip(north_wwr, south_wwr):
        idf.set_wwr(north, construction="Project External Window", orientation="north")
        idf.set_wwr(south, construction="Project External Window", orientation="south")
        idf.run(
            output_prefix=f"{north}_{south}_",
            output_directory="tests/tutorial",
            expandobjects=True,
            verbose="q",
        )
    results = []
    for north, south in zip(north_wwr, south_wwr):
        eso = ESO(f"tests/tutorial/{north}_{south}_out.eso")
        heat = eso.total_kwh("Zone Ideal Loads Supply Air Total Heating Energy")
        cool = eso.total_kwh("Zone Ideal Loads Supply Air Total Cooling Energy")
        results.append([north, south, heat, cool, heat + cool])
    # print out the results
    headers = ["WWR-N", "WWR-S", "Heat", "Cool", "Total"]
    header_format = "{:>10}" * (len(headers))
    print(header_format.format(*headers))
    row_format = "{:>10.1f}" * (len(headers))
    for row in results:
        print(row_format.format(*row))