honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/cli/translate.py

@@ -0,0 +1,400 @@
+"""honeybee radiance translation commands."""
+import click
+import sys
+import os
+import logging
+import json
+import zipfile
+import shutil
+
+from ladybug.commandutil import process_content_to_output
+from honeybee_radiance.reader import string_to_dicts
+from honeybee_radiance.mutil import dict_to_modifier, modifier_class_from_type_string
+
+from honeybee.model import Model
+from ladybug.futil import preparedir, unzip_file
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands for translating Honeybee JSON files to/from RAD.')
+def translate():
+    pass
+
+
+@translate.command('model-to-rad-folder')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--folder', help='Folder into which the model Radiance '
+    'folders will be written. If None, the files will be output in the '
+    'same location as the model_file.', default=None, show_default=True
+)
+@click.option(
+    '--grid', '-g', multiple=True, help='List of grids to be included in folder. By '
+    'default all the sensor grids will be exported. You can also use wildcards here. '
+    'For instance first_floor_* will select all the sensor grids that has an identifier '
+    'that starts with first_floor. To filter based on group_identifier use /. For '
+    'example daylight/* will select all the grids that belong to daylight group.')
+@click.option(
+    '--view', '-v', multiple=True, help='List of views to be included in folder. By '
+    'default all the views will be exported. You can also use wildcards to filter '
+    'multiple views. For instance first_floor_* will select all the views that has an '
+    'identifier that starts with first_floor. To filter based on group_identifier use '
+    '/. For example daylight/* will select all the views that belong to daylight group.')
+@click.option(
+    '--full-match/--no-full-match', help='Flag to note whether the grids and'
+    'views should be filtered by their identifiers as full matches. Setting '
+    'this to True indicates that wildcard symbols will not be used in the '
+    'filtering of grids and views.', default=False, show_default=True)
+@click.option(
+    '--config-file', '-c', help='An optional config file path to modify the '
+    'default folder names. If None, folder.cfg in honeybee-radiance-folder '
+    'will be used.', default=None, show_default=True)
+@click.option(
+    '--minimal/--maximal', '-min/-max', help='Flag to note whether the radiance strings '
+    'should be written in a minimal format (with spaces instead of line '
+    'breaks).', default=False, show_default=True)
+@click.option(
+    '--no-grid-check/--grid-check', ' /-gc', help='Flag to note whether the '
+    'model should be checked for the presence of sensor grids. If the check '
+    'is set and the model has no grids, an explicit error will be raised.',
+    default=True, show_default=True)
+@click.option(
+    '--no-view-check/--view-check', ' /-vc', help='Flag to note whether the '
+    'model should be checked for the presence of views. If the check '
+    'is set and the model has no views, an explicit error will be raised.',
+    default=True, show_default=True)
+@click.option(
+    '--create-grids', '-cg', default=False, show_default=True, is_flag=True,
+    help='Flag to note whether sensor grids should be created if none exists. '
+    'This will only create sensor grids for rooms if there are no sensor grids '
+    'in the model.'
+)
+@click.option(
+    '--log-file', help='Optional log file to output the path of the radiance '
+    'folder generated from the model. By default this will be printed '
+    'to stdout', type=click.File('w'), default='-')
+def model_to_rad_folder_cli(
+        model_file, folder, view, grid, full_match, config_file, minimal,
+        no_grid_check, no_view_check, create_grids, log_file):
+    """Translate a Model file into a Radiance Folder.
+
+    \b
+    Args:
+        model_file: Full path to a Model JSON file (HBJSON) or a Model
+            pkl (HBpkl) file. This can also be a zipped version of a Radiance
+            folder, in which case this command will simply unzip the file
+            into the --folder and no other operations will be performed on it.
+    """
+    try:
+        grid_check = not no_grid_check
+        view_check = not no_view_check
+        model_to_rad_folder(
+            model_file, folder, view, grid, full_match, config_file,
+            minimal, grid_check, view_check, log_file, create_grids=create_grids)
+    except Exception as e:
+        _logger.exception('Model translation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def model_to_rad_folder(
+        model_file, folder=None, view=None, grid=None, full_match=False, config_file=None,
+        minimal=False, grid_check=False, view_check=False, log_file=None,
+        no_full_match=True, maximal=True, no_grid_check=False, no_view_check=False,
+        create_grids=False):
+    """Translate a Model file into a Radiance Folder.
+
+    Args:
+        model_file: Full path to a Model JSON file (HBJSON) or a Model
+            pkl (HBpkl) file. This can also be a zipped version of a Radiance
+            folder, in which case this command will simply unzip the file
+            into the --folder and no other operations will be performed on it.
+        folder: Folder into which the model Radiance folders will be written.
+            If None, the files will be output in the same location as the model_file.
+        view: List of grids to be included in folder. By default all the sensor
+            grids will be exported. You can also use wildcards here. For instance
+            first_floor_* will select all the sensor grids that has an identifier
+            that starts with first_floor. To filter based on group_identifier
+            use /. For example daylight/* will select all the grids that belong
+            to daylight group. (Default: None).
+        grid: List of views to be included in folder. By default all the views
+            will be exported. You can also use wildcards to filter multiple views.
+            For instance first_floor_* will select all the views that has an
+            identifier that starts with first_floor. To filter based on
+            group_identifier use /. For example daylight/* will select all the
+            views that belong to daylight group. (Default: None).
+        full_match: Boolean to note whether the grids and views should be
+            filtered by their identifiers as full matches. Setting this to
+            True indicates that wildcard symbols will not be used in the
+            filtering of grids and views. (Default: False).
+        config_file: An optional config file path to modify the default folder
+            names. If None, folder.cfg in honeybee-radiance-folder will be used.
+        minimal: Boolean to note whether the radiance strings should be written
+            in a minimal format (with spaces instead of line breaks). (Default: False).
+        grid_check: Boolean to note whether the model should be checked for the
+            presence of sensor grids. If the check is set and the model has no
+            grids, an explicit error will be raised. (Default: False).
+        view_check: Boolean to note whether the model should be checked for the
+            presence of views. If the check is set and the model has no views,
+            an explicit error will be raised. (Default: False).
+        log_file: Optional log file to output the path of the radiance folder
+            generated from the model. If None, it will be returned from this method.
+    """
+    # set the default folder if it's not specified
+    if folder is None:
+        folder = os.path.dirname(os.path.abspath(model_file))
+
+    # first check to see if the model_file is a zipped radiance folder
+    if zipfile.is_zipfile(model_file):
+        unzip_file(model_file, folder)
+        if log_file is None:
+            return folder
+        else:
+            log_file.write(folder)
+    else:
+        # re-serialize the Model and perform any checks
+        model = Model.from_file(model_file)
+
+        if create_grids:
+            if not model.properties.radiance.has_sensor_grids:
+                sensor_grids = []
+
+                unit_conversion = {
+                    'Meters': 1,
+                    'Millimeters': 0.001,
+                    'Centimeters': 0.01,
+                    'Feet': 0.3048,
+                    'Inches': 0.0254
+                }
+
+                if model.units in ['Meters', 'Millimeters', 'Centimeters']:
+                    grid_size = 0.5 / unit_conversion[model.units]
+                    offset = 0.76 / unit_conversion[model.units]
+                    wall_offset = 0.3 / unit_conversion[model.units]
+                else:  # assume IP units
+                    grid_size = 2 * 0.3048 / unit_conversion[model.units]
+                    offset = 2.5 * 0.3048 / unit_conversion[model.units]
+                    wall_offset = 1 * 0.3048 / unit_conversion[model.units]
+
+                for room in model.rooms:
+                    sensor_grids.append(room.properties.radiance.generate_sensor_grid(
+                        grid_size, offset=offset, wall_offset=wall_offset))
+                model.properties.radiance.sensor_grids = sensor_grids
+                model.to_hbjson('output_model', '.')
+        else:
+            file_extension = os.path.splitext(model_file)[1]
+            shutil.copy(model_file, 'output_model' + file_extension)
+
+        if grid_check and len(model.properties.radiance.sensor_grids) == 0:
+            raise ValueError('Model contains no sensor grids. These are required.')
+        if view_check and len(model.properties.radiance.views) == 0:
+            raise ValueError('Model contains no views These are required.')
+
+        # translate the model to a radiance folder
+        rad_fold = model.to.rad_folder(
+            model, folder, config_file, minimal, views=view, grids=grid,
+            full_match=full_match
+        )
+
+        if log_file is None:
+            return rad_fold
+        else:
+            log_file.write(rad_fold)
+
+
+@translate.command('model-to-rad')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--blk', help='Flag to note whether the "blacked out" version '
+              'of the geometry should be output, which is useful for direct studies '
+              'and isolation studies of individual apertures.',
+              default=False, show_default=True)
+@click.option('--minimal/--maximal', help='Flag to note whether the radiance strings '
+              'should be written in a minimal format (with spaces instead of line '
+              'breaks).', default=False, show_default=True)
+@click.option('--output-file', help='Optional RAD file to output the RAD string of the '
+              'translation. By default this will be printed out to stdout',
+              type=click.File('w'), default='-', show_default=True)
+def model_to_rad_cli(model_file, blk, minimal, output_file):
+    """Translate a Model file to a Radiance string.
+
+    The resulting strings will include all geometry (Rooms, Faces, Shades, Apertures,
+    Doors) and all modifiers. However, it does not include any states for dynamic
+    geometry and will only write the default state for each dynamic object. To
+    correctly account for dynamic objects, model-to-rad-folder should be used.
+
+    \b
+    Args:
+        model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
+    """
+    try:
+        model_to_rad(model_file, blk, minimal, output_file)
+    except Exception as e:
+        _logger.exception('Model translation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def model_to_rad(model_file, blk=False, minimal=False, output_file=None, maximal=True):
+    """Translate a Model file to a Radiance string.
+
+    The resulting strings will include all geometry (Rooms, Faces, Shades, Apertures,
+    Doors) and all modifiers. However, it does not include any states for dynamic
+    geometry and will only write the default state for each dynamic object. To
+    correctly account for dynamic objects, model-to-rad-folder should be used.
+
+    Args:
+        model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
+        blk: Boolean to note whether the "blacked out" version of the geometry
+            should be output, which is useful for direct studies and isolation
+            studies of individual apertures.
+        minimal: Boolean to note whether the radiance strings should be written
+            in a minimal format (with spaces instead of line breaks).
+        output_file: Optional RAD file to output the RAD string of the translation.
+            If None, the string will be returned from this method. (Default: None).
+    """
+    # re-serialize the Model and translate the model to a rad string
+    model = Model.from_file(model_file)
+    model_str, modifier_str = model.to.rad(model, blk, minimal)
+    rad_str_list = ['# ========  MODEL MODIFIERS ========', modifier_str,
+                    '# ========  MODEL GEOMETRY ========', model_str]
+    rad_str = '\n\n'.join(rad_str_list)
+
+    # write out the rad string
+    return process_content_to_output(rad_str, output_file)
+
+
+@translate.command('model-radiant-enclosure-info')
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--folder', help='Folder into which the radiant enclosure info JSONs '
+              'will be written. If None, the files will be output in the'
+              'same location as the model_file in an enclosure subfolder.',
+              default=None, show_default=True)
+@click.option('--log-file', help='Optional log file to output the list of generated '
+              'radiant enclosure JSONs. By default this will be printed '
+              'to stdout', type=click.File('w'), default='-')
+def model_radiant_enclosure_info(model_file, folder, log_file):
+    """Translate a Model file to a list of JSONs with radiant enclosure information.
+
+    There will be one radiant enclosure JSON for each Model SensorGrid written to
+    the output folder and each JSON will contain a list of values about which room
+    (or radiant enclosure) each sensor is located. JSONs will also include a mapper
+    that links the integers of each sensor with the identifier(s) of a room.
+
+    \b
+    Args:
+        model_file: Full path to a Model JSON file (HBJSON) or a Model pkl (HBpkl) file.
+    """
+    try:
+        # re-serialize the Model
+        model = Model.from_file(model_file)
+
+        # set the default folder if it's not specified
+        if folder is None:
+            folder = os.path.dirname(os.path.abspath(model_file))
+            folder = os.path.join(folder, 'enclosure')
+        if not os.path.isdir(folder):
+            preparedir(folder)  # create the directory if it's not there
+
+        # loop through sensor grids and build up the radiant enclosure dicts
+        grids_info = []
+        for grid in model.properties.radiance.sensor_grids:
+            # write an enclosure JSON for each grid
+            enc_dict = grid.enclosure_info_dict(model)
+            enclosure_file = os.path.join(folder, '{}.json'.format(grid.identifier))
+            with open(enclosure_file, 'w') as fp:
+                json.dump(enc_dict, fp)
+            g_info = {
+                'id': grid.identifier,
+                'enclosure_path': enclosure_file,
+                'enclosure_full_path': os.path.abspath(enclosure_file),
+                'count': grid.count
+            }
+            grids_info.append(g_info)
+
+        # write out the list of radiant enclosure JSON info
+        log_file.write(json.dumps(grids_info, indent=4))
+    except Exception as e:
+        _logger.exception('Model translation to radiant enclosure failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@translate.command('modifiers-to-rad')
+@click.argument('modifier-json', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--minimal/--maximal', help='Flag to note whether the radiance strings '
+              'should be written in a minimal format (with spaces instead of line '
+              'breaks).', default=False, show_default=True)
+@click.option('--output-file', help='Optional RAD file to output the RAD string of the '
+              'translation. By default this will be printed out to stdout',
+              type=click.File('w'), default='-', show_default=True)
+def modifier_to_rad(modifier_json, minimal, output_file):
+    """Translate a Modifier JSON file to an RAD using direct-to-rad translators.
+    \n
+    Args:
+        modifier_json: Full path to a Modifier JSON file. This file should
+            either be an array of non-abridged Modifiers or a dictionary where
+            the values are non-abridged Modifiers.
+    """
+    try:
+        # re-serialize the Modifiers to Python
+        with open(modifier_json) as json_file:
+            data = json.load(json_file)
+        mod_list = data.values() if isinstance(data, dict) else data
+        mod_objs = []
+        for mod_dict in mod_list:
+            m_class = modifier_class_from_type_string(mod_dict['type'].lower())
+            mod_objs.append(m_class.from_dict(mod_dict))
+
+        # create the RAD strings
+        rad_str_list = []
+        rad_str_list.extend([mod.to_radiance(minimal) for mod in mod_objs])
+        rad_str = '\n\n'.join(rad_str_list)
+
+        # write out the RAD file
+        output_file.write(rad_str)
+    except Exception as e:
+        _logger.exception('Modifier translation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@translate.command('modifiers-from-rad')
+@click.argument('modifier-rad', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option('--output-file', help='Optional JSON file to output the JSON string of the'
+              'translation. By default this will be printed out to stdout',
+              type=click.File('w'), default='-', show_default=True)
+def modifier_from_rad(modifier_rad, output_file):
+    """Translate a Modifier JSON file to a honeybee JSON as an array of modifiers.
+    \n
+    Args:
+        modifier_rad: Full path to a Modifier .rad or .mat file. Only the modifiers
+            and materials in this file will be extracted.
+    """
+    try:
+        # re-serialize the Modifiers to Python
+        mod_objs = []
+        with open(modifier_rad) as f:
+            rad_dicts = string_to_dicts(f.read())
+            for mod_dict in rad_dicts:
+                mod_objs.append(dict_to_modifier(mod_dict))
+
+        # create the honeybee dictionaries
+        json_dicts = [mod.to_dict() for mod in mod_objs]
+
+        # write out the JSON file
+        output_file.write(json.dumps(json_dicts))
+    except Exception as e:
+        _logger.exception('Modifier translation failed.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance/cli/util.py

@@ -0,0 +1,121 @@
+from ladybug.analysisperiod import AnalysisPeriod
+from datetime import datetime
+import copy
+
+
+def get_hoys(start_date, start_time, end_date, end_time, timestep, leap_year):
+    """Return list of hours from start date, star hour, end date and end hour.
+
+    Date should be formatted as MMM-DD (e.g JUL-21) and hours must be formatted
+    as HH:MM (e.g 18:30).
+    """
+    # convert datetimes
+    try:
+        start_date = datetime.strptime(start_date, '%b-%d')
+    except ValueError as e:
+        raise ValueError('Wrong input for start date:\n\t{}'.format(e))
+    try:
+        start_time = datetime.strptime(start_time, '%H:%M')
+    except ValueError as e:
+        raise ValueError('Wrong input for start time:\n\t{}'.format(e))
+    try:
+        end_date = datetime.strptime(end_date, '%b-%d')
+    except ValueError as e:
+        raise ValueError('Wrong input for end date:\n\t{}'.format(e))
+    try:
+        end_time = datetime.strptime(end_time, '%H:%M')
+    except ValueError as e:
+        raise ValueError('Wrong input for end time:\n\t{}'.format(e))
+
+    org_end_time = copy.copy(end_time)
+    if end_time.minute != 0:
+        if end_time.hour != 23:
+            end_time = datetime(
+                end_time.year, end_time.month, end_time.day, end_time.hour + 1, 0
+            )
+        else:
+            end_time = datetime(
+                end_time.year, end_time.month, end_time.day + 1, 0, 0
+            )
+    ap = AnalysisPeriod(
+        start_date.month, start_date.day, start_time.hour,
+        end_date.month, end_date.day, end_time.hour,
+        timestep, leap_year
+    )
+
+    hoys = ap.hoys
+
+    # filter start and end hours if needed
+    start_index = 0
+    end_index = None
+    if start_time.minute != 0:
+        # remove the hours that are smaller than this hour
+        for start_index, h in enumerate(hoys):
+            if round(60 * h) % 60 >= start_time.minute:
+                break
+
+    if org_end_time.minute != 0:
+        for end_index, h in enumerate(reversed(hoys)):
+            if (60 * h) % 60 <= org_end_time.minute:
+                break
+
+    if start_index == 0 and end_index is None:
+        return hoys
+    elif end_index is None:
+        return hoys[start_index:]
+    else:
+        return hoys[start_index: -1 * (end_index + 1)]
+
+
+def handle_operator(operator):
+    """Handle operator for rmtxop command."""
+    if operator == '+':
+        return '+'
+    elif operator == '-':
+        return '+ -s -1.0'
+    elif operator == '/':
+        return '/'
+    elif operator == '*':
+        return '"*"'
+    else:
+        raise ValueError('Invalid operator: %s' % operator)
+
+
+def remove_header(input_file):
+    """Remove the header text from a Radiance matrix file."""
+    inf = open(input_file)
+    first_line = next(inf)
+    if first_line[:10] == '#?RADIANCE':
+        for line in inf:
+            if line[:7] == 'FORMAT=':
+                # pass next empty line
+                next(inf)
+                first_line = next(inf)
+                break
+            continue
+    return first_line, inf
+
+
+def get_compare_func(include_min, include_max, comply):
+    if include_max and include_min:
+        if comply:
+            compare = lambda value, minimum, maximum: minimum <= value <= maximum
+        else:
+            compare = lambda value, minimum, maximum: not (minimum <= value <= maximum)
+    elif not include_max and not include_min:
+        if comply:
+            compare = lambda value, minimum, maximum: minimum < value < maximum
+        else:
+            compare = lambda value, minimum, maximum: not (minimum < value < maximum)
+    elif include_max and not include_min:
+        if comply:
+            compare = lambda value, minimum, maximum: minimum < value <= maximum
+        else:
+            compare = lambda value, minimum, maximum: not (minimum < value <= maximum)
+    elif not include_max and include_min:
+        if comply:
+            compare = lambda value, minimum, maximum: minimum <= value < maximum
+        else:
+            compare = lambda value, minimum, maximum: not (minimum <= value < maximum)
+
+    return compare