honeybee-energy 1.116.106__py3-none-any.whl

honeybee_energy/cli/settings.py

@@ -0,0 +1,569 @@
+"""commands to generate honeybee energy simulation settings."""
+import click
+import sys
+import logging
+import json
+import os
+
+from ladybug.futil import preparedir
+from ladybug.analysisperiod import AnalysisPeriod
+from ladybug.dt import Date
+from honeybee.config import folders
+from honeybee.model import Model
+
+from honeybee_energy.simulation.parameter import SimulationParameter
+from honeybee_energy.simulation.runperiod import RunPeriod
+from honeybee_energy.simulation.control import SimulationControl
+from honeybee_energy.construction.windowshade import WindowConstructionShade
+from honeybee_energy.construction.dynamic import WindowConstructionDynamic
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands for simulating Honeybee JSON files in EnergyPlus.')
+def settings():
+    pass
+
+
+@settings.command('default-sim-par')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--reporting-frequency', '-rf', help='Text for the frequency at which '
+    'the outputs are reported. (Default: Hourly). Choose from the following: '
+    'Annual, Monthly, Daily, Hourly, Timestep', default='Hourly', type=str)
+@click.option(
+    '--run-period', '-rp', help='An AnalysisPeriod or RunPeriod string '
+    'to dictate the start and end of the simulation '
+    '(eg. "6/21 to 9/21 between 0 and 23 @1"). If unspecified, the '
+    'simulation will be for the whole year.', default=None, type=str)
+@click.option(
+    '--north', '-n', default=0, type=float, show_default=True,
+    help='Number from -360 to 360 for the counterclockwise difference between '
+    'North and the positive Y-axis in degrees. 90 is west; 270 is east')
+@click.option(
+    '--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+    'the design days in the ddy-file should be filtered to only include 99.6 '
+    'and 0.4 design days.', default=True, show_default=True)
+@click.option(
+    '--efficiency-standard', '-es', help='Text to set the efficiency standard, which '
+    'will automatically set the efficiencies of all HVAC equipment when provided. '
+    'Note that providing a standard here will cause the OpenStudio translation '
+    'process to perform an additional sizing calculation with EnergyPlus, '
+    'which is needed since the default efficiencies of equipment vary depending '
+    'on their size. THIS WILL SIGNIFICANTLY INCREASE TRANSLATION TIME. '
+    'However, it is often worthwhile when the goal is to match the '
+    'HVAC specification with a particular standard.Choose from the following: '
+    'DOE_Ref_Pre_1980, DOE_Ref_1980_2004, ASHRAE_2004, ASHRAE_2007, ASHRAE_2010, '
+    'ASHRAE_2013, ASHRAE_2016, ASHRAE_2019', default=None, type=str)
+@click.option(
+    '--climate-zone', '-cz', help='Text indicating the ASHRAE climate zone to be '
+    'used with the efficiency_standard. When unspecified, the climate zone will be '
+    'inferred from the design days. This input can be a single integer (in which '
+    'case it is interpreted as A) or it can include the A, B, or C qualifier '
+    '(eg. 3C).', default=None, type=str)
+@click.option(
+    '--building-type', '-bt', help='Text for the building type to be used in '
+    'the efficiency_standard. If the type is not recognized or is None, it will '
+    'be assumed that the building is a generic NonResidential.',
+    default=None, type=str)
+@click.option(
+    '--output-file', '-f', help='Optional file to output the JSON string of '
+    'the simulation parameters. By default, it will be printed to stdout.',
+    type=click.File('w'), default='-', show_default=True)
+def default_sim_par(
+        ddy_file, reporting_frequency, run_period, north, filter_des_days,
+        efficiency_standard, climate_zone, building_type, output_file):
+    """Get a SimulationParameter JSON with default outputs for energy use only.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+    """
+    try:
+        sim_par = SimulationParameter()
+        sim_par.output.add_zone_energy_use()
+        sim_par.output.add_hvac_energy_use()
+        sim_par.output.add_electricity_generation()
+        sim_par.output.reporting_frequency = reporting_frequency
+        _apply_run_period(run_period, sim_par)
+        sim_par.north_angle = north
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+        if efficiency_standard is not None and efficiency_standard != '':
+            sim_par.sizing_parameter.efficiency_standard = efficiency_standard
+        if climate_zone is not None and climate_zone != '':
+            sim_par.sizing_parameter.climate_zone = climate_zone
+        if building_type is not None and building_type != '':
+            sim_par.sizing_parameter.building_type = building_type
+        output_file.write(json.dumps(sim_par.to_dict()))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameter.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('load-balance-sim-par')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--load-type', '-lt', help='A text value to set the type of load outputs '
+              'requested. Choose from the following:\nAll - all energy use '
+              'including heat lost from the zone\nTotal - the total load added to the '
+              'zone (both sensible and latent)\nSensible - the sensible load added to '
+              'the zone\nLatent - the latent load added to the zone.',
+              type=str, default='Total', show_default=True)
+@click.option('--reporting-frequency', '-rf', help='Text for the frequency at which '
+              'the outputs are reported. (Default: Hourly). Choose from the following: '
+              'Annual, Monthly, Daily, Hourly Timestep', default='Hourly', type=str)
+@click.option('--run-period', '-rp', help='An AnalysisPeriod or RunPeriod string '
+              'to dictate the start and end of the simulation '
+              '(eg. "6/21 to 9/21 between 0 and 23 @1"). If unspecified, the '
+              'simulation will be for the whole year.', default=None, type=str)
+@click.option('--north', '-n', default=0, type=float, show_default=True,
+              help='Number from -360 to 360 for the counterclockwise difference between '
+              'North and the positive Y-axis in degrees. 90 is west; 270 is east')
+@click.option('--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+              'the design days in the ddy-file should be filtered to only include 99.6 '
+              'and 0.4 design days.', default=True, show_default=True)
+@click.option('--output-file', '-f', help='Optional file to output the JSON string of '
+              'the simulation parameters. By default, it will be printed to stdout.',
+              type=click.File('w'), default='-', show_default=True)
+def load_balance_sim_par(ddy_file, load_type, reporting_frequency, run_period, north,
+                         filter_des_days, output_file):
+    """Get a SimulationParameter JSON with outputs for thermal load balances.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+    """
+    try:
+        sim_par = SimulationParameter()
+        sim_par.output.add_zone_energy_use(load_type)
+        gl_load_type = load_type if load_type != 'All' else 'Total'
+        sim_par.output.add_gains_and_losses(gl_load_type)
+        sim_par.output.add_surface_energy_flow()
+        sim_par.output.reporting_frequency = reporting_frequency
+        _apply_run_period(run_period, sim_par)
+        sim_par.north_angle = north
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+        output_file.write(json.dumps(sim_par.to_dict()))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameter.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('comfort-sim-par')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--run-period', '-rp', help='An AnalysisPeriod or RunPeriod string '
+              'to dictate the start and end of the simulation '
+              '(eg. "6/21 to 9/21 between 0 and 23 @1"). If unspecified, the '
+              'simulation will be for the whole year.', default=None, type=str)
+@click.option('--north', '-n', default=0, type=float, show_default=True,
+              help='Number from -360 to 360 for the counterclockwise difference between '
+              'North and the positive Y-axis in degrees. 90 is west; 270 is east')
+@click.option('--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+              'the design days in the ddy-file should be filtered to only include 99.6 '
+              'and 0.4 design days.', default=True, show_default=True)
+@click.option('--output-file', '-f', help='Optional file to output the JSON string of '
+              'the simulation parameters. By default, it will be printed to stdout.',
+              type=click.File('w'), default='-', show_default=True)
+def comfort_sim_par(ddy_file, run_period, north, filter_des_days, output_file):
+    """Get a SimulationParameter JSON with outputs for thermal comfort mapping.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+    """
+    try:
+        sim_par = SimulationParameter()
+        sim_par.shadow_calculation.solar_distribution = \
+            'FullInteriorAndExteriorWithReflections'
+        sim_par.output.add_comfort_metrics()
+        sim_par.output.add_surface_temperature()
+        _apply_run_period(run_period, sim_par)
+        sim_par.north_angle = north
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+        output_file.write(json.dumps(sim_par.to_dict()))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameter.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('sizing-sim-par')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--load-type', '-lt', help='A text value to set the type of load outputs '
+              'requested. Choose from the following:\nAll - all energy use '
+              'including heat lost from the zone\nTotal - the total load added to the '
+              'zone (both sensible and latent)\nSensible - the sensible load added to '
+              'the zone\nLatent - the latent load added to the zone.',
+              type=str, default='Total', show_default=True)
+@click.option('--north', '-n', default=0, type=float, show_default=True,
+              help='Number from -360 to 360 for the counterclockwise difference between '
+              'North and the positive Y-axis in degrees. 90 is west; 270 is east')
+@click.option('--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+              'the design days in the ddy-file should be filtered to only include 99.6 '
+              'and 0.4 design days.', default=True, show_default=True)
+@click.option('--output-file', '-f', help='Optional file to output the JSON string of '
+              'the simulation parameters. By default, it will be printed to stdout.',
+              type=click.File('w'), default='-', show_default=True)
+def sizing_sim_par(ddy_file, load_type, north, filter_des_days, output_file):
+    """Get a SimulationParameter JSON with outputs and run period for HVAC sizing.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+    """
+    try:
+        sim_par = SimulationParameter()
+        sim_par.output.add_zone_energy_use(load_type)
+        gl_load_type = load_type if load_type != 'All' else 'Total'
+        sim_par.output.add_gains_and_losses(gl_load_type)
+        sim_par.output.add_surface_energy_flow()
+        sim_par.simulation_control = SimulationControl(True, True, True, True, False)
+        sim_par.north_angle = north
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+        output_file.write(json.dumps(sim_par.to_dict()))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameter.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('custom-sim-par')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument('output-names', nargs=-1)
+@click.option('--reporting-frequency', '-rf', help='Text for the frequency at which '
+              'the outputs are reported. (Default: Hourly). Choose from the following: '
+              'Annual, Monthly, Daily, Hourly Timestep', default='Hourly', type=str)
+@click.option('--run-period', '-rp', help='An AnalysisPeriod or RunPeriod string '
+              'to dictate the start and end of the simulation '
+              '(eg. "6/21 to 9/21 between 0 and 23 @1"). If unspecified, the '
+              'simulation will be for the whole year.', default=None, type=str)
+@click.option('--north', '-n', default=0, type=float, show_default=True,
+              help='Number from -360 to 360 for the counterclockwise difference between '
+              'North and the positive Y-axis in degrees. 90 is west; 270 is east')
+@click.option('--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+              'the design days in the ddy-file should be filtered to only include 99.6 '
+              'and 0.4 design days.', default=True, show_default=True)
+@click.option('--output-file', '-f', help='Optional file to output the JSON string of '
+              'the simulation parameters. By default, it will be printed to stdout.',
+              type=click.File('w'), default='-', show_default=True)
+def custom_sim_par(ddy_file, output_names, reporting_frequency, run_period, north,
+                   filter_des_days, output_file):
+    """Get a SimulationParameter JSON with an option for custom outputs.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+        output_names: Any number of EnergyPlus output names as strings (eg.
+            'Surface Window System Solar Transmittance'. These outputs will be
+            requested from the simulation.
+    """
+    try:
+        sim_par = SimulationParameter()
+        for output_name in output_names:
+            sim_par.output.add_output(output_name)
+        sim_par.output.reporting_frequency = reporting_frequency
+        _apply_run_period(run_period, sim_par)
+        sim_par.north_angle = north
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+        output_file.write(json.dumps(sim_par.to_dict()))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameter.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('orientation-sim-pars')
+@click.argument('ddy-file', type=click.Path(
+    file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument('north-angles', nargs=-1, type=float)
+@click.option('--default-outputs/--no-default-outputs', ' /-nd', help='Flag to note '
+              'whether the default outputs for energy usage should be included in '
+              'the simulation parameters or no outputs should be requested except '
+              'for those explicitly listed with --output-name.',
+              default=True, show_default=True)
+@click.option('--output-name', '-o', help='Any number of EnergyPlus output names as '
+              'strings (eg. Surface Window System Solar Transmittance). These outputs '
+              'will be requested from the simulation.',
+              type=click.STRING, multiple=True, default=None, show_default=True)
+@click.option('--reporting-frequency', '-rf', help='Text for the frequency at which '
+              'the outputs are reported. (Default: Hourly). Choose from the following: '
+              'Annual, Monthly, Daily, Hourly Timestep', default='Hourly', type=str)
+@click.option('--run-period', '-rp', help='An AnalysisPeriod or RunPeriod string '
+              'to dictate the start and end of the simulation '
+              '(eg. "6/21 to 9/21 between 0 and 23 @1"). If unspecified, the '
+              'simulation will be for the whole year.', default=None, type=str)
+@click.option('--start-north', '-n', default=0, type=float, show_default=True,
+              help='Number from -360 to 360 for the starting north angle. This will be '
+              'added to the north-angles in order to shift all norths.')
+@click.option('--filter-des-days/--all-des-days', ' /-all', help='Flag to note whether '
+              'the design days in the ddy-file should be filtered to only include 99.6 '
+              'and 0.4 design days.', default=True, show_default=True)
+@click.option(
+    '--efficiency-standard', '-es', help='Text to set the efficiency standard, which '
+    'will automatically set the efficiencies of all HVAC equipment when provided. '
+    'Note that providing a standard here will cause the OpenStudio translation '
+    'process to perform an additional sizing calculation with EnergyPlus, '
+    'which is needed since the default efficiencies of equipment vary depending '
+    'on their size. THIS WILL SIGNIFICANTLY INCREASE TRANSLATION TIME. '
+    'However, it is often worthwhile when the goal is to match the '
+    'HVAC specification with a particular standard.Choose from the following: '
+    'DOE_Ref_Pre_1980, DOE_Ref_1980_2004, ASHRAE_2004, ASHRAE_2007, ASHRAE_2010, '
+    'ASHRAE_2013, ASHRAE_2016, ASHRAE_2019', default=None, type=str)
+@click.option(
+    '--climate-zone', '-cz', help='Text indicating the ASHRAE climate zone to be '
+    'used with the efficiency_standard. When unspecified, the climate zone will be '
+    'inferred from the design days. This input can be a single integer (in which '
+    'case it is interpreted as A) or it can include the A, B, or C qualifier '
+    '(eg. 3C).', default=None, type=str)
+@click.option(
+    '--building-type', '-bt', help='Text for the building type to be used in '
+    'the efficiency_standard. If the type is not recognized or is None, it will '
+    'be assumed that the building is a generic NonResidential.', default=None, type=str)
+@click.option('--folder', '-f', help='Output folder for the simulation parameter JSONS.',
+              default=None, show_default=True,
+              type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
+@click.option('--log-file', '-log', help='Optional log file to output the paths of the '
+              'simulation parameters. By default the list will be printed out to '
+              'stdout.', type=click.File('w'), default='-')
+def orientation_sim_pars(
+        ddy_file, north_angles, default_outputs, output_name, reporting_frequency,
+        run_period, start_north, filter_des_days,
+        efficiency_standard, climate_zone, building_type, folder, log_file):
+    """Get SimulationParameter JSONs with different north angles for orientation studies.
+
+    \b
+    Args:
+        ddy_file: Full path to a DDY file that will be used to specify design days
+            within the simulation parameter.
+        north_angles: Any number of values between -360 and 360 for the counterclockwise
+            difference between the North and the positive Y-axis in degrees. 90 is
+            West and 270 is East.
+    """
+    try:
+        # get a default folder if none was specified
+        if folder is None:
+            folder = os.path.join(folders.default_simulation_folder, 'orientation_study')
+        preparedir(folder, remove_content=False)
+
+        # create a base set of simulation parameters to be edited parametrically
+        sim_par = SimulationParameter()
+        if default_outputs:
+            sim_par.output.add_zone_energy_use()
+            sim_par.output.add_hvac_energy_use()
+            sim_par.output.add_electricity_generation()
+        for out_name in output_name:
+            sim_par.output.add_output(out_name)
+        sim_par.output.reporting_frequency = reporting_frequency
+        _apply_run_period(run_period, sim_par)
+        if os.path.isfile(ddy_file):
+            _apply_design_days(ddy_file, filter_des_days, sim_par)
+
+        # set the sizing parameters if specified
+        if efficiency_standard is not None and efficiency_standard != '':
+            sim_par.sizing_parameter.efficiency_standard = efficiency_standard
+        if climate_zone is not None and climate_zone != '':
+            sim_par.sizing_parameter.climate_zone = climate_zone
+        if building_type is not None and building_type != '':
+            sim_par.sizing_parameter.building_type = building_type
+
+        # shift all of the north angles by the start_north if specified
+        if start_north != 0:
+            north_angles = [angle + start_north for angle in north_angles]
+            for i, angle in enumerate(north_angles):
+                angle = angle - 360 if angle > 360 else angle
+                angle = angle + 360 if angle < -360 else angle
+                north_angles[i] = angle
+
+        # loop through the north angles and write a simulation parameter for each
+        json_files = []
+        for angle in north_angles:
+            sim_par.north_angle = angle
+            base_name = 'sim_par_north_{}'.format(int(angle))
+            file_name = '{}.json'.format(base_name)
+            file_path = os.path.join(folder, file_name)
+            with open(file_path, 'w') as fp:
+                json.dump(sim_par.to_dict(), fp)
+            sp_info = {
+                'id': base_name,
+                'path': file_name,
+                'full_path': os.path.abspath(file_path)
+            }
+            json_files.append(sp_info)
+        log_file.write(json.dumps(json_files))
+    except Exception as e:
+        _logger.exception('Failed to generate simulation parameters.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('run-period')
+@click.argument('start-month', type=int)
+@click.argument('start-day', type=int)
+@click.argument('end-month', type=int)
+@click.argument('end-day', type=int)
+@click.option('--start-day-of-week', '-dow', help='Text for the day of the week '
+              'on which the simulation starts.', type=str, default='Sunday',
+              show_default=True)
+@click.option('--holidays', '-h', help='Text for the holidays within the simulation. '
+              'Dates should be formatted as follows: "[day int] [month text]" '
+              '(eg. "25 Dec"). If not specified, no holidays are applied.',
+              type=str, default=None, show_default=True, multiple=True)
+@click.option('--output-file', '-f', help='Optional file to output the JSON string of '
+              'the run period. By default, it will be printed to stdout.',
+              type=click.File('w'), default='-', show_default=True)
+def run_period(start_month, start_day, end_month, end_day, start_day_of_week,
+               holidays, output_file):
+    """Get a RunPeriod string that can be used to set the simulation run period.
+
+    \b
+    Args:
+        start_month: Start month (1-12).
+        start_day: Start day (1-31).
+        end_month: End month (1-12).
+        end_day: End day (1-31).
+    """
+    try:
+        # create the run period
+        a_period = AnalysisPeriod(start_month, start_day, 0, end_month, end_day, 23)
+        run_period = RunPeriod.from_analysis_period(a_period)
+        # set the start day of the week if it is input
+        if start_day_of_week is not None:
+            run_period.start_day_of_week = start_day_of_week.title()
+        # set the holidays if requested.
+        if holidays:
+            dates = tuple(Date.from_date_string(date) for date in holidays)
+            run_period.holidays = dates
+        output_file.write(str(run_period))
+    except Exception as e:
+        _logger.exception('Failed to generate run period.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@settings.command('dynamic-window-outputs')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--base-idf', '-i', help='An optional base IDF file to which the outputs '
+    'for dynamic windows will be appended.', default=None, show_default=True,
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--output-file', '-f', help='Optional IDF file to output the list of outputs to '
+    'add to the EnergyPlus simulation. By default this will be printed out to '
+    'stdout', type=click.File('w'), default='-', show_default=True)
+def dynamic_window_outputs(model_file, base_idf, output_file):
+    """Get an IDF string that requests transmittance outputs for dynamic windows.
+
+    This should be used within comfort mapping workflows to request transmittance
+    outputs for dynamic windows. Note that the output is just an IDF text string
+    that should be incorporated in the energy simulation by means of additional
+    strings or additional IDF.
+
+    \b
+    Args:
+        model_file: Full path to a Model JSON or Pkl file to be analyzed for
+            dynamic window constructions.
+    """
+    try:
+        # define templates to be reused for each dynamic window
+        out_vars = [
+            'Surface Window Transmitted Beam to Beam Solar Radiation Rate',
+            'Surface Window Transmitted Beam to Diffuse Solar Radiation Rate',
+            'Surface Window Transmitted Diffuse Solar Radiation Rate',
+            'Surface Outside Face Incident Solar Radiation Rate per Area',
+        ]
+        out_per_win = ['Output:Variable, {}, ' + var + ', Timestep;' for var in out_vars]
+
+        # define dynamic constructions and re-serialize the Model to Python
+        dyn_con = (WindowConstructionShade, WindowConstructionDynamic)
+        model = Model.from_file(model_file)
+
+        # load up the contents of the base IDF file if it exists
+        out_strs = []
+        if base_idf is not None and os.path.isfile(base_idf):
+            with open(base_idf, "r") as add_idf_file:
+                out_strs.append(add_idf_file.read())
+
+        # loop through the apertures and add outputs to be requested
+        for room in model.rooms:
+            for face in room.faces:
+                for ap in face.apertures:
+                    if isinstance(ap.properties.energy.construction, dyn_con):
+                        for op in out_per_win:
+                            out_strs.append(op.format(ap.identifier))
+
+        # write the IDF string
+        output_file.write('\n'.join(out_strs))
+    except Exception as e:
+        _logger.exception('Model baseline geometry creation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def _load_run_period_str(run_period_str):
+    """Load a RunPeriod from a string of a run period or analysis period.
+
+    Args:
+        run_period_str: A string of a RunPeriod or AnalysisPeriod to be loaded.
+    """
+    if run_period_str is not None and run_period_str != '' \
+            and run_period_str != 'None':
+        if run_period_str.startswith('RunPeriod'):
+            return RunPeriod.from_string(run_period_str)
+        else:
+            return RunPeriod.from_analysis_period(
+                AnalysisPeriod.from_string(run_period_str))
+
+
+def _apply_run_period(run_period_json, sim_par):
+    """Helper function to apply a RunPeriod from a JSON to simulation parameters.
+
+    Args:
+        run_period_json: A JSON file of a RunPeriod or AnalysisPeriod to be loaded.
+        sim_par: A SimulationParameter object.
+    """
+    run_period = _load_run_period_str(run_period_json)
+    if run_period is not None:
+        sim_par.run_period = run_period
+
+
+def _apply_design_days(ddy_file, filter_des_days, sim_par):
+    """Apply design days from a DDY file to simulation parameters.
+
+    Args:
+        ddy_file: Path to a .ddy file.
+        filter_des_days: Boolean for whether design days should be filtered.
+        sim_par: A SimulationPArameter object.
+    """
+    try:
+        if filter_des_days:
+            sim_par.sizing_parameter.add_from_ddy_996_004(ddy_file)
+        else:
+            sim_par.sizing_parameter.add_from_ddy(ddy_file)
+    except AssertionError:  # no design days in the DDY file
+        pass