honeybee-energy 1.115.3__py2.py3-none-any.whl → 1.116.1__py2.py3-none-any.whl

honeybee_energy/cli/translate.py

@@ -11,6 +11,7 @@ from ladybug.commandutil import process_content_to_output
 from ladybug.analysisperiod import AnalysisPeriod
 from ladybug.epw import EPW
 from ladybug.stat import STAT
+from ladybug.futil import preparedir
 from honeybee.model import Model
 from honeybee.typing import clean_rad_string
 from honeybee.config import folders as hb_folders
@@ -22,7 +23,8 @@ from honeybee_energy.construction.window import WindowConstruction
 from honeybee_energy.schedule.dictutil import dict_to_schedule
 from honeybee_energy.schedule.ruleset import ScheduleRuleset
 from honeybee_energy.properties.model import ModelEnergyProperties
-from honeybee_energy.run import run_osw, from_gbxml_osw, from_osm_osw, from_idf_osw, \
+from honeybee_energy.run import to_openstudio_sim_folder, run_osw, \
+    from_gbxml_osw, from_osm_osw, from_idf_osw, \
     _parse_os_cli_failure, HB_OS_MSG
 from honeybee_energy.writer import energyplus_idf_version, _preprocess_model_for_trace
 from honeybee_energy.config import folders
@@ -35,6 +37,146 @@ def translate():
     pass
 
 
+@translate.command('model-to-sim-folder')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument('epw-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--sim-par-json', '-sp', help='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.', default=None, show_default=True,
+              type=click.Path(exists=False, file_okay=True, dir_okay=False,
+                              resolve_path=True))
+@click.option('--measures', '-m', help='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.', default=None, show_default=True,
+              type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
+@click.option('--additional-string', '-as', help='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.', default=None, type=str)
+@click.option('--additional-idf', '-ai', help='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.',
+              default=None, show_default=True,
+              type=click.Path(exists=False, file_okay=True, dir_okay=False,
+                              resolve_path=True))
+@click.option('--folder', '-f', help='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.',
+              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 '
+              'generated files (osw, osm, idf) if successfully'
+              ' created. By default the list will be printed out to stdout',
+              type=click.File('w'), default='-', show_default=True)
+def simulate_model(
+    model_file, epw_file, sim_par_json, measures, additional_string, additional_idf,
+    folder, log_file
+):
+    """Simulate a Model in EnergyPlus.
+
+    \b
+    Args:
+        model_file: Full path to a Model file as a HBJSON or HBPkl.
+        epw_file: Full path to an .epw file.
+    """
+    try:
+        # get a ddy variable that might get used later
+        epw_folder, epw_file_name = os.path.split(epw_file)
+        ddy_file = os.path.join(epw_folder, epw_file_name.replace('.epw', '.ddy'))
+        stat_file = os.path.join(epw_folder, epw_file_name.replace('.epw', '.stat'))
+
+        # sense what type of file has been input
+        proj_name = os.path.basename(model_file).lower()
+
+        # set the default folder to the default if it's not specified
+        if folder is None:
+            for ext in ('.hbjson', '.json', '.hbpkl', '.pkl'):
+                proj_name = proj_name.replace(ext, '')
+            folder = os.path.join(folders.default_simulation_folder, proj_name)
+            folder = os.path.join(folder, 'openstudio')
+        preparedir(folder, remove_content=False)
+
+        # process the simulation parameters and write new ones if necessary
+        def ddy_from_epw(epw_file, sim_par):
+            """Produce a DDY from an EPW file."""
+            epw_obj = EPW(epw_file)
+            des_days = [epw_obj.approximate_design_day('WinterDesignDay'),
+                        epw_obj.approximate_design_day('SummerDesignDay')]
+            sim_par.sizing_parameter.design_days = des_days
+
+        if sim_par_json is None or not os.path.isfile(sim_par_json):
+            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 = 'Monthly'
+        else:
+            with open(sim_par_json) as json_file:
+                data = json.load(json_file)
+            sim_par = SimulationParameter.from_dict(data)
+        if len(sim_par.sizing_parameter.design_days) == 0 and \
+                os.path.isfile(ddy_file):
+            try:
+                sim_par.sizing_parameter.add_from_ddy_996_004(ddy_file)
+            except AssertionError:  # no design days within the DDY file
+                ddy_from_epw(epw_file, sim_par)
+        elif len(sim_par.sizing_parameter.design_days) == 0:
+            ddy_from_epw(epw_file, sim_par)
+        if sim_par.sizing_parameter.climate_zone is None and \
+                os.path.isfile(stat_file):
+            stat_obj = STAT(stat_file)
+            sim_par.sizing_parameter.climate_zone = stat_obj.ashrae_climate_zone
+
+        # process the measures input if it is specified
+        base_osw = None
+        if measures is not None and measures != '' and os.path.isdir(measures):
+            for f_name in os.listdir(measures):
+                if f_name.lower().endswith('.osw'):
+                    base_osw = os.path.join(measures, f_name)
+                    # write the path of the measures folder into the OSW
+                    with open(base_osw) as json_file:
+                        osw_dict = json.load(json_file)
+                    osw_dict['measure_paths'] = [os.path.abspath(measures)]
+                    with open(base_osw, 'w') as fp:
+                        json.dump(osw_dict, fp)
+                    break
+
+        # Write the osw file to translate the model to osm
+        strings_to_inject = additional_string if additional_string is not None else ''
+        if additional_idf is not None and os.path.isfile(additional_idf):
+            with open(additional_idf, "r") as add_idf_file:
+                strings_to_inject = strings_to_inject + '\n' + add_idf_file.read()
+
+        # run the Model re-serialization and convert to OSM, OSW, and IDF
+        osm, osw, idf = None, None, None
+        model = Model.from_file(model_file)
+        osm, osw, idf = to_openstudio_sim_folder(
+            model, folder, epw_file=epw_file, sim_par=sim_par, enforce_rooms=True,
+            base_osw=base_osw, strings_to_inject=strings_to_inject,
+            print_progress=True)
+        gen_files = [osm]
+        if osw is not None:
+            gen_files.append(osw)
+        if idf is not None:
+            gen_files.append(idf)
+
+        log_file.write(json.dumps(gen_files, indent=4))
+    except Exception as e:
+        _logger.exception('Model simulation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
 @translate.command('model-to-osm')
 @click.argument('model-file', type=click.Path(
     exists=True, file_okay=True, dir_okay=False, resolve_path=True))

honeybee_energy/run.py

@@ -239,32 +239,33 @@ def to_openstudio_sim_folder(
                 osw_dict['file_paths'].append(schedule_directory)
         if epw_file is not None:
             osw_dict['weather_file'] = epw_file
-        if 'measure_paths' not in osw_dict:
-            osw_dict['measure_paths'] = []
-        measure_paths = set()  # set of all unique measure paths
-        # ensure measures are correctly ordered
-        m_dict = {'ModelMeasure': [], 'EnergyPlusMeasure': [], 'ReportingMeasure': []}
-        for measure in additional_measures:
-            m_dict[measure.type].append(measure)
-        sorted_measures = m_dict['ModelMeasure'] + m_dict['EnergyPlusMeasure'] + \
-            m_dict['ReportingMeasure']
-        # add the measures and the measure paths to the OSW
-        for measure in sorted_measures:
-            measure.validate()  # ensure that all required arguments have values
-            measure_paths.add(os.path.dirname(measure.folder))
-            osw_dict['steps'].append(measure.to_osw_dict())  # add measure to workflow
-        for m_path in measure_paths:
-            osw_dict['measure_paths'].append(m_path)
-        # if there were reporting measures, add the ladybug adapter to get sim progress
-        adapter = folders.honeybee_adapter_path
-        if adapter is not None:
-            if 'run_options' not in osw_dict:
-                osw_dict['run_options'] = {}
-            osw_dict['run_options']['output_adapter'] = {
-                'custom_file_name': adapter,
-                'class_name': 'HoneybeeAdapter',
-                'options': {}
-            }
+        if additional_measures is not None:
+            if 'measure_paths' not in osw_dict:
+                osw_dict['measure_paths'] = []
+            measure_paths = set()  # set of all unique measure paths
+            # ensure measures are correctly ordered
+            m_dict = {'ModelMeasure': [], 'EnergyPlusMeasure': [], 'ReportingMeasure': []}
+            for measure in additional_measures:
+                m_dict[measure.type].append(measure)
+            sorted_measures = m_dict['ModelMeasure'] + m_dict['EnergyPlusMeasure'] + \
+                m_dict['ReportingMeasure']
+            # add the measures and the measure paths to the OSW
+            for measure in sorted_measures:
+                measure.validate()  # ensure that all required arguments have values
+                measure_paths.add(os.path.dirname(measure.folder))
+                osw_dict['steps'].append(measure.to_osw_dict())  # add measure to workflow
+            for m_path in measure_paths:
+                osw_dict['measure_paths'].append(m_path)
+            # if there were reporting measures, add the ladybug adapter to get sim progress
+            adapter = folders.honeybee_adapter_path
+            if adapter is not None:
+                if 'run_options' not in osw_dict:
+                    osw_dict['run_options'] = {}
+                osw_dict['run_options']['output_adapter'] = {
+                    'custom_file_name': adapter,
+                    'class_name': 'HoneybeeAdapter',
+                    'options': {}
+                }
         # write the dictionary to a workflow.osw
         osw = os.path.abspath(os.path.join(directory, 'workflow.osw'))
         if (sys.version_info < (3, 0)):  # we need to manually encode it as UTF-8

{honeybee_energy-1.115.3.dist-info → honeybee_energy-1.116.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-energy
-Version: 1.115.3
+Version: 1.116.1
 Summary: Energy simulation library for honeybee.
 Home-page: https://github.com/ladybug-tools/honeybee-energy
 Author: Ladybug Tools
@@ -17,7 +17,7 @@ License-File: LICENSE
 Requires-Dist: honeybee-core==1.61.12
 Requires-Dist: honeybee-standards==2.0.7
 Provides-Extra: openstudio
-Requires-Dist: honeybee-openstudio==0.2.3; extra == "openstudio"
+Requires-Dist: honeybee-openstudio==0.2.4; extra == "openstudio"
 Provides-Extra: standards
 Requires-Dist: honeybee-energy-standards==2.3.0; extra == "standards"
 

{honeybee_energy-1.115.3.dist-info → honeybee_energy-1.116.1.dist-info}/RECORD

@@ -11,7 +11,7 @@ honeybee_energy/internalmass.py,sha256=8b4NuQpi5jBue31Q56YvMTx1iXPEEKmKe9-J9aLh5
 honeybee_energy/measure.py,sha256=S4MBqC8eLWzqCLFeTa0uQQgWE6-NOPcmUU0wlu9uXB0,17403
 honeybee_energy/programtype.py,sha256=yJJc0WYZPc7-m27h5hlDXW-jmwPu8CMhhP_AlwDorqM,34221
 honeybee_energy/reader.py,sha256=PTiv0WCfc3kGPA--__8QiR-JhnRgq1VkcU-PvvzLjzM,1856
-honeybee_energy/run.py,sha256=vHC5QR5j5tK5iqSlWwnrTTpEFlaNbl3cIISQbutq6lQ,74488
+honeybee_energy/run.py,sha256=DDi-1wS-C1_i32nxV00-F2TciMqXJxFNaTEvdIjJxnE,74636
 honeybee_energy/shw.py,sha256=9CifpIhF0q48DtKb58vF_zoeouZ15OAYcWTGL6NJJQY,12727
 honeybee_energy/writer.py,sha256=lIDc_jZjIcWtoRItiyb5iwXwtgBg3WRQa58KrH7nTZU,48437
 honeybee_energy/baseline/__init__.py,sha256=pAN81W4x__LwHO6nsvV3FIdoSyI9cDAeS1xM-LeOtvU,91
@@ -34,7 +34,7 @@ honeybee_energy/cli/result.py,sha256=Cqg1KwkDqeqLjpBn8dpWXvHqg_UyxNmLTgj64gfpBWY
 honeybee_energy/cli/setconfig.py,sha256=c22bvTyCH1ieebkP39-YI2uI3irjVjGOL90ysrRdgmg,4386
 honeybee_energy/cli/settings.py,sha256=gDPQDN1XmYiIxEag9aYboWoifrCcD2AYOEw3M_b8_v4,28731
 honeybee_energy/cli/simulate.py,sha256=5i5_O8m_iXHXukr53TVyqfNmwZSUqgNiLB8K9EbNjLA,18589
-honeybee_energy/cli/translate.py,sha256=Dds7lxr0tvYNaGAaoEK1PILCIRKTtNQreKWmo_fZRqo,73884
+honeybee_energy/cli/translate.py,sha256=TUeIYZHsvJ3VZxmjM2NFhILqrcREQjDG5cUd9S0FJVs,81361
 honeybee_energy/cli/validate.py,sha256=viXYu6Xx_LOdDK2NUqpwIr6QyWd5_AGgKZTCYUmpaoA,9339
 honeybee_energy/construction/__init__.py,sha256=oCfbVLV3m_Imqf8JK0_IyVdKuMJphPQOCQ5_MjcH9Us,37
 honeybee_energy/construction/_base.py,sha256=s-ha1K2FsbZELYZEqcBBjgkFnA9Ik-LxCnFsDVUsSVc,14321
@@ -156,9 +156,9 @@ honeybee_energy/ventcool/opening.py,sha256=ZywoADlNQ6_8OfjV71ZUpbCAetQrRVj7aprBj
 honeybee_energy/ventcool/simulation.py,sha256=gMF4sgCQ5R4iFWPnvvB3wxgeP_zEwnWl71ObIIe4XGU,14423
 tests/fixtures/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/fixtures/userdata_fixtures.py,sha256=yDvBR6nsltel_U8hUoUsJ6yufPKTR7Wnsgxe68HtswQ,313
-honeybee_energy-1.115.3.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_energy-1.115.3.dist-info/METADATA,sha256=i8FGbz0_ST4tzUBam2In3IyT9aW9mmbW86ZFREWLcgA,3562
-honeybee_energy-1.115.3.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-honeybee_energy-1.115.3.dist-info/entry_points.txt,sha256=QOMJbH-StaxT4hCjskZtqetNCMNioP3ZiuhoLQ6MANc,63
-honeybee_energy-1.115.3.dist-info/top_level.txt,sha256=V9Lz0281hfT83Fy0fSdn_6vwRK9vTQe1_LQXd0_-gAI,22
-honeybee_energy-1.115.3.dist-info/RECORD,,
+honeybee_energy-1.116.1.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_energy-1.116.1.dist-info/METADATA,sha256=YOd378iDxoTI7DqjdmNdYOglkm1q5aWdQkgKlrWyWKY,3562
+honeybee_energy-1.116.1.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+honeybee_energy-1.116.1.dist-info/entry_points.txt,sha256=QOMJbH-StaxT4hCjskZtqetNCMNioP3ZiuhoLQ6MANc,63
+honeybee_energy-1.116.1.dist-info/top_level.txt,sha256=V9Lz0281hfT83Fy0fSdn_6vwRK9vTQe1_LQXd0_-gAI,22
+honeybee_energy-1.116.1.dist-info/RECORD,,