trnslator/tests/test_idf.py

import os
import random
import subprocess

import trnslator as tr
import matplotlib as mpl

# use agg backend so you don't need a display on travis-ci
import pytest
from path import Path

import trnslator.settings
from trnslator import EnergyPlusProcessError, get_eplus_dirs, settings, \
    parallel_process

mpl.use("Agg")


# given, when, then
# or
# arrange, act, assert


def test_small_home_data(clean_config):
    file = (
        get_eplus_dirs(settings.ep_version)
        / "ExampleFiles"
        / "BasicsFiles"
        / "AdultEducationCenter.idf"
    )
    file = tr.copy_file(file)
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"
    return tr.run_eplus(
        file, wf, prep_outputs=True, design_day=True, expandobjects=True, verbose="q"
    )


def test_necb(config):
    """Test all necb files with design_day = True"""

    necb_dir = Path("tests/input_data/necb")
    files = necb_dir.glob("*.idf")
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"
    rundict = {
        file: dict(
            eplus_file=file,
            weather_file=wf,
            expandobjects=True,
            verbose="q",
            design_day=True,
            output_report="sql",
        )
        for file in files
    }
    result = parallel_process(rundict, tr.run_eplus, use_kwargs=True)

    assert not any(isinstance(a, Exception) for a in result.values())


def test_load_idf(config):
    """Will load an idf object"""

    files = [
        get_eplus_dirs(settings.ep_version) / "ExampleFiles" / "5ZoneNightVent1.idf",
        get_eplus_dirs(settings.ep_version)
        / "ExampleFiles"
        / "BasicsFiles"
        / "AdultEducationCenter.idf",
    ]

    obj = {os.path.basename(file): tr.load_idf(file) for file in files}
    assert isinstance(obj, dict)


def test_load_old(config):
    files = [
        "tests/input_data/problematic/nat_ventilation_SAMPLE0.idf",
        get_eplus_dirs(settings.ep_version) / "ExampleFiles" / "5ZoneNightVent1.idf",
    ]

    obj = {os.path.basename(file): tr.load_idf(file) for file in files}

    assert not any(isinstance(a, Exception) for a in obj.values())


@pytest.mark.parametrize(
    "ep_version",
    [trnslator.settings.ep_version, None],
    ids=["specific-ep-version", "no-specific-ep-version"],
)
def test_run_olderv(clean_config, ep_version):
    """Will run eplus on a file that needs to be upgraded with one that does
    not"""
    tr.settings.use_cache = False
    files = [
        "tests/input_data/problematic/nat_ventilation_SAMPLE0.idf",
        get_eplus_dirs(settings.ep_version) / "ExampleFiles" / "5ZoneNightVent1.idf",
    ]
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"
    files = tr.copy_file(files)
    rundict = {
        file: dict(
            eplus_file=file,
            weather_file=wf,
            ep_version=ep_version,
            annual=True,
            prep_outputs=True,
            expandobjects=True,
            verbose="q",
            output_report="sql",
        )
        for file in files
    }
    result = {file: tr.run_eplus(**rundict[file]) for file in files}


@pytest.mark.xfail(
    raises=(subprocess.CalledProcessError, FileNotFoundError, EnergyPlusProcessError)
)
def test_run_olderv_problematic(clean_config):
    """Will run eplus on a file that needs to be upgraded and that should
    fail. Will be ignored in the test suite"""

    file = "tests/input_data/problematic/RefBldgLargeOfficeNew2004_v1.4_7.2_5A_USA_IL_CHICAGO-OHARE.idf"
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"
    tr.run_eplus(
        file, wf, prep_outputs=True, annual=True, expandobjects=True, verbose="q"
    )


def test_run_eplus_from_idf(clean_config):
    file = get_eplus_dirs(settings.ep_version) / "ExampleFiles" / "5ZoneNightVent1.idf"
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"

    idf = tr.load_idf(file, weather_file=wf)
    sql = idf.run_eplus(prep_outputs=True, output_report="sql")

    assert sql


@pytest.mark.parametrize(
    "archetype, area",
    [
        ("FullServiceRestaurant", 511),
        pytest.param(
            "Hospital",
            22422,
            marks=pytest.mark.xfail(reason="Difference cannot be explained"),
        ),
        ("LargeHotel", 11345),
        ("LargeOffice", 46320),
        ("MediumOffice", 4982),
        ("MidriseApartment", 3135),
        ("Outpatient", 3804),
        ("PrimarySchool", 6871),
        ("QuickServiceRestaurant", 232),
        ("SecondarySchool", 19592),
        ("SmallHotel", 4013),
        ("SmallOffice", 511),
        pytest.param(
            "RetailStandalone",
            2319,
            marks=pytest.mark.xfail(reason="Difference cannot be explained"),
        ),
        ("RetailStripmall", 2090),
        pytest.param(
            "Supermarket",
            4181,
            marks=pytest.mark.skip("Supermarket " "missing from " "BTAP " "database"),
        ),
        ("Warehouse", 4835),
    ],
)
def test_area(archetype, area):
    """Test the conditioned_area property against published values
    desired values taken from https://github.com/canmet-energy/btap"""
    import numpy as np
    from trnslator import load_idf

    idf_file = Path("tests/input_data/necb/").glob("*{}*.idf".format(archetype))
    idf = load_idf(next(iter(idf_file)))
    np.testing.assert_almost_equal(actual=idf.area_conditioned, desired=area, decimal=0)


def test_wwr():
    from trnslator import load_idf

    idf_file = Path("tests/input_data/necb/").glob(
        "*{}*.idf".format("FullServiceRestaurant")
    )
    idf = load_idf(next(iter(idf_file)))
    print(idf.name)
    print(idf.wwr(round_to=10))


def test_partition_ratio():
    from trnslator import load_idf

    idf_file = Path("tests/input_data/necb/").glob("*LargeOffice*.idf")
    idf = load_idf(next(iter(idf_file)))
    print(idf.partition_ratio)


def test_space_cooling_profile(config):
    from trnslator import load_idf

    file = (
        get_eplus_dirs(settings.ep_version)
        / "ExampleFiles"
        / "BasicsFiles"
        / "AdultEducationCenter.idf"
    )
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"

    idf = load_idf(file, None, weather_file=wf)

    assert not idf.space_cooling_profile().empty


def test_space_heating_profile(config):
    from trnslator import load_idf

    file = "tests/input_data/necb/NECB 2011-Warehouse-NECB HDD Method-CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw.idf"
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"

    idf = load_idf(file, None, weather_file=wf)

    assert not idf.space_heating_profile().empty


def test_dhw_profile(config):
    from trnslator import load_idf

    file = "tests/input_data/necb/NECB 2011-Warehouse-NECB HDD Method-CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw.idf"
    wf = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"

    idf = load_idf(file, None, weather_file=wf)

    shw = idf.service_water_heating_profile()
    assert shw.sum() > 0
    print(shw.resample("M").sum())


def test_old_than_change_args(clean_config):
    """Should upgrade file only once even if run_eplus args are changed afterwards"""
    from trnslator import run_eplus

    file = (
        get_eplus_dirs(settings.ep_version)
        / "ExampleFiles"
        / "RefBldgQuickServiceRestaurantNew2004_Chicago.idf"
    )
    epw = "tests/input_data/CAN_PQ_Montreal.Intl.AP.716270_CWEC.epw"

    idf = run_eplus(file, epw, prep_outputs=True, output_report="sql_file")

    idf = run_eplus(file, epw, prep_outputs=True, output_report="sql_file")

    idf = run_eplus(file, epw, prep_outputs=True, output_report="sql")