honeybee_energy.cli.simulate module

honeybee energy simulation running commands.

honeybee_energy.cli.simulate.simulate_model(model_file, epw_file, sim_par_json=None, measures=None, additional_string=None, additional_idf=None, report_units=None, viz_variable=None, folder=None, skip_no_rooms=False, log_file=None, enforce_rooms=True)[source]

Simulate a Model in EnergyPlus.

Parameters:

  • model_file – Full path to a Model file as either a HBJSON, OSM, or IDF.

  • epw_file – Full path to an .epw file.

  • sim_par_json – Full path to a honeybee energy SimulationParameter JSON that describes all of the settings for the simulation. This will be ignored if the input model-file is an OSM or IDF.

  • measures – Full path to a folder containing an OSW JSON be used as the base for the execution of the OpenStudio CLI. While this OSW can contain paths to measures that exist anywhere on the machine, the best practice is to copy the measures into this measures folder and use relative paths within the OSW. This makes it easier to move the inputs for this command from one machine to another.

  • additional_string – An additional IDF text string to get appended to the IDF before simulation. The input should include complete EnergyPlus objects as a single string following the IDF format. This input can be used to include small EnergyPlus objects that are not currently supported by honeybee.

  • additional_idf – An IDF file with text to be appended before simulation. This input can be used to include large EnergyPlus objects that are not currently supported by honeybee.

  • report_units –

    Text to set the units of the OpenStudio Results report that this command can output for each EnergyPlus model. Choose from the following:

    • none - no results report will be produced

    • si - all units will be in SI

    • ip - all units will be in IP

  • viz_variable – An optional list of text values for EnergyPlus output variables to be visualized on the geometry in an output HTML report. For example, [“Zone Air System Sensible Heating Rate”, “Zone Air System Sensible Cooling Rate”]. If None, no view_data report is produced.

  • folder – Folder on this computer, into which the IDF and result files will be written. If None, the files will be output to the honeybee default simulation folder and placed in a project folder with the same name as the model-file.

  • skip_no_rooms – Boolean to note whether the simulation should be skipped if the Model has no Rooms and is therefore not simulate-able in EnergyPlus. Otherwise, this command will fail with an explicit error about the lack of rooms. Note that the input model must be a HBJSON in order for this to work correctly.

  • log_file – Optional log file to output the paths of the generated files (osw, osm, idf, sql, zsz, rdd, html, err) if successfully created. By default the list will be returned from this method.