def test_simulation_control_init_from_idf(): """Test the initialization of SimulationControl from_idf.""" sim_control = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) idf_str = sim_control.to_idf() rebuilt_sim_control = SimulationControl.from_idf(idf_str) assert sim_control == rebuilt_sim_control assert rebuilt_sim_control.to_idf() == idf_str
def test_simulation_control_dict_methods(): """Test the to/from dict methods.""" sim_control = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) cntrl_dict = sim_control.to_dict() new_sim_control = SimulationControl.from_dict(cntrl_dict) assert new_sim_control == sim_control assert cntrl_dict == new_sim_control.to_dict()
def test_simulation_control_equality(): """Test the equality of SimulationControl objects.""" sim_control = SimulationControl() sim_control_dup = sim_control.duplicate() sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) assert sim_control is sim_control assert sim_control is not sim_control_dup assert sim_control == sim_control_dup sim_control_dup.run_for_sizing_periods = True assert sim_control != sim_control_dup assert sim_control != sim_control_alt
def simulation_par_detailed(directory): sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() output.include_html = True output.reporting_frequency = 'Daily' output.add_summary_report('Annual Building Utility Performance Summary') output.add_summary_report('Climatic Data Summary') output.add_summary_report('Envelope Summary') sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) run_period.daylight_saving_time = DaylightSavingTime(Date(3, 12), Date(11, 5)) run_period.start_day_of_week = 'Monday' run_period.holidays = [Date(1, 1), Date(3, 17), Date(7, 4)] sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation( solar_distribution='FullInteriorAndExteriorWithReflections', calculation_method='PixelCounting', calculation_update_method='Timestep') sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(None, 1, 1) relative_path = './scripts/ddy/chicago.ddy' sizing_alt.add_from_ddy_996_004(relative_path) sim_par.sizing_parameter = sizing_alt dest_file = os.path.join(directory, 'simulation_par_detailed.json') with open(dest_file, 'w') as fp: json.dump(sim_par.to_dict(), fp, indent=4)
def test_simulation_parameter_to_dict_detailed(): """Test the to_dict method with a detailed SimulationParameter.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() output.include_html = True output.reporting_frequency = 'Daily' output.add_summary_report('Annual Building Utility Performance Summary') output.add_summary_report('Climatic Data Summary') output.add_summary_report('Envelope Summary') sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) run_period.daylight_saving_time = DaylightSavingTime( Date(3, 12), Date(11, 5)) run_period.start_day_of_week = 'Monday' run_period.holidays = [Date(1, 1), Date(3, 17), Date(7, 4)] sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation(calculation_frequency=20) sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(None, 1, 1) relative_path = './tests/ddy/chicago.ddy' sizing_alt.add_from_ddy_996_004(relative_path) sim_par.sizing_parameter = sizing_alt sim_par_dict = sim_par.to_dict() assert 'outputs' in sim_par_dict['output'] assert 'holidays' in sim_par_dict['run_period'] assert 'daylight_saving_time' in sim_par_dict['run_period'] assert 'design_days' in sim_par_dict['sizing_parameter']
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 _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)
def dict_to_simulation(sim_dict, raise_exception=True): """Get a Python object of any Simulation object from a dictionary. Args: sim_dict: A dictionary of any Honeybee energy simulation object. Note that this should be a non-abridged dictionary to be valid. raise_exception: Boolean to note whether an excpetion should be raised if the object is not identified as a simulation object. Default: True. Returns: A Python object derived from the input sim_dict. """ try: # get the type key from the dictionary sim_type = sim_dict['type'] except KeyError: raise ValueError('Simulation dictionary lacks required "type" key.') if sim_type == 'SimulationControl': return SimulationControl.from_dict(sim_dict) elif sim_type == 'RunPeriod': return RunPeriod.from_dict(sim_dict) elif sim_type == 'DaylightSavingTime': return DaylightSavingTime.from_dict(sim_dict) elif sim_type == 'ShadowCalculation': return ShadowCalculation.from_dict(sim_dict) elif sim_type == 'SizingParameter': return SizingParameter.from_dict(sim_dict) elif sim_type == 'SimulationOutput': return SimulationOutput.from_dict(sim_dict) elif sim_type == 'SimulationParameter': return SimulationParameter.from_dict(sim_dict) elif raise_exception: raise ValueError( '{} is not a recognized energy Simulation type'.format(sim_type))
def test_simulation_parameter_setability(): """Test the setting of properties of SimulationParameter.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output assert sim_par.output == output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period assert sim_par.run_period == run_period sim_par.timestep = 4 assert sim_par.timestep == 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt assert sim_par.simulation_control == sim_control_alt shadow_calc_alt = ShadowCalculation('FullExteriorWithReflections') sim_par.shadow_calculation = shadow_calc_alt assert sim_par.shadow_calculation == shadow_calc_alt sizing_alt = SizingParameter(None, 1, 1) relative_path = './tests/ddy/chicago_monthly.ddy' sizing_alt.add_from_ddy(relative_path) sim_par.sizing_parameter = sizing_alt assert sim_par.sizing_parameter == sizing_alt sim_par.north_angle = 20 assert sim_par.north_angle == 20 sim_par.terrain_type = 'Ocean' assert sim_par.terrain_type == 'Ocean'
def test_simulation_control_init(): """Test the initialization of SimulationControl and basic properties.""" sim_control = SimulationControl() str(sim_control) # test the string representation assert sim_control.do_zone_sizing assert sim_control.do_system_sizing assert sim_control.do_plant_sizing assert not sim_control.run_for_sizing_periods assert sim_control.run_for_run_periods
def test_simulation_parameter_init(): """Test the initialization of SimulationParameter and basic properties.""" sim_par = SimulationParameter() str(sim_par) # test the string representation assert sim_par.output == SimulationOutput() assert sim_par.run_period == RunPeriod() assert sim_par.timestep == 6 assert sim_par.simulation_control == SimulationControl() assert sim_par.shadow_calculation == ShadowCalculation() assert sim_par.sizing_parameter == SizingParameter()
def test_simulation_control_setability(): """Test the setting of properties of SimulationControl.""" sim_control = SimulationControl() sim_control.do_zone_sizing = False assert not sim_control.do_zone_sizing sim_control.do_system_sizing = False assert not sim_control.do_system_sizing sim_control.do_plant_sizing = False assert not sim_control.do_plant_sizing sim_control.run_for_sizing_periods = True assert sim_control.run_for_sizing_periods sim_control.run_for_run_periods = False assert not sim_control.run_for_run_periods
def test_simulation_parameter_init_from_idf(): """Test the initialization of SimulationParameter from_idf.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation(calculation_frequency=20) sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(1, 1) sim_par.sizing_parameter = sizing_alt idf_str = sim_par.to_idf() rebuilt_sim_par = SimulationParameter.from_idf(idf_str) assert sim_par == rebuilt_sim_par assert rebuilt_sim_par.to_idf() == idf_str
def test_simulation_parameter_dict_methods(): """Test the to/from dict methods.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation(calculation_frequency=20) sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(1, 1) sim_par.sizing_parameter = sizing_alt sim_par_dict = sim_par.to_dict() new_sim_par = SimulationParameter.from_dict(sim_par_dict) assert new_sim_par == sim_par assert sim_par_dict == new_sim_par.to_dict()
def test_simulation_parameter_setability(): """Test the setting of properties of SimulationParameter.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output assert sim_par.output == output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period assert sim_par.run_period == run_period sim_par.timestep = 4 assert sim_par.timestep == 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt assert sim_par.simulation_control == sim_control_alt shadow_calc_alt = ShadowCalculation('FullExteriorWithReflections') sim_par.shadow_calculation = shadow_calc_alt assert sim_par.shadow_calculation == shadow_calc_alt sizing_alt = SizingParameter(1, 1) sim_par.sizing_parameter = sizing_alt assert sim_par.sizing_parameter == sizing_alt
def test_simulation_parameter_dict_methods(): """Test the to/from dict methods.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation(calculation_frequency=20) sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(None, 1, 1) relative_path = './tests/ddy/chicago.ddy' sizing_alt.add_from_ddy_996_004(relative_path) sim_par.sizing_parameter = sizing_alt sim_par_dict = sim_par.to_dict() new_sim_par = SimulationParameter.from_dict(sim_par_dict) new_sim_par.sizing_parameter.apply_location(sizing_alt[0].location) assert new_sim_par == sim_par assert sim_par_dict == new_sim_par.to_dict()
def test_simulation_parameter_init_from_idf(): """Test the initialization of SimulationParameter from_idf.""" sim_par = SimulationParameter() output = SimulationOutput() output.add_zone_energy_use() sim_par.output = output run_period = RunPeriod(Date(1, 1), Date(6, 21)) sim_par.run_period = run_period sim_par.timestep = 4 sim_control_alt = SimulationControl(run_for_sizing_periods=True, run_for_run_periods=False) sim_par.simulation_control = sim_control_alt shadow_calc_alt = ShadowCalculation(calculation_frequency=20) sim_par.shadow_calculation = shadow_calc_alt sizing_alt = SizingParameter(None, 1, 1) relative_path = './tests/ddy/chicago.ddy' sizing_alt.add_from_ddy_996_004(relative_path) sim_par.sizing_parameter = sizing_alt idf_str = sim_par.to_idf() rebuilt_sim_par = SimulationParameter.from_idf(idf_str) rebuilt_sim_par.sizing_parameter.apply_location(sizing_alt[0].location) assert sim_par == rebuilt_sim_par assert rebuilt_sim_par.to_idf() == idf_str
be run for the run periods. Default: True. Returns: sim_control: A SimulationControl object that can be connected to the "HB Simulation Parameter" component in order to specify which types of EnergyPlus calculations to run. """ ghenv.Component.Name = "HB Simulation Control" ghenv.Component.NickName = 'SimControl' ghenv.Component.Message = '0.1.0' ghenv.Component.Category = 'HB-Energy' ghenv.Component.SubCategory = '5 :: Simulate' ghenv.Component.AdditionalHelpFromDocStrings = "2" try: from honeybee_energy.simulation.control import SimulationControl except ImportError as e: raise ImportError('\nFailed to import honeybee_energy:\n\t{}'.format(e)) # set default values _do_zone_sizing_ = _do_zone_sizing_ if _do_zone_sizing_ is not None else True _do_system_sizing_ = _do_system_sizing_ if _do_system_sizing_ is not None else True _do_plant_sizing_ = _do_plant_sizing_ if _do_plant_sizing_ is not None else True _for_sizing_period_ = _for_sizing_period_ if _for_sizing_period_ is not None else False _for_run_period_ = _for_run_period_ if _for_run_period_ is not None else True # create the object sim_control = SimulationControl(_do_zone_sizing_, _do_system_sizing_, _do_plant_sizing_, _for_sizing_period_, _for_run_period_)