honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/__init__.py

@@ -0,0 +1,11 @@
+"""honeybee-radiance library."""
+
+from honeybee.logutil import get_logger
+
+# use the same logger settings across honeybee extensions
+# this does NOT mean that the logs will be written to the same file but they will have
+# the same formatting, level, etc.
+logger = get_logger(name=__name__)
+
+# load all functions that extends honeybee core library
+import honeybee_radiance._extend_honeybee

honeybee_radiance/__main__.py

@@ -0,0 +1,4 @@
+from honeybee_radiance.cli import radiance
+
+if __name__ == '__main__':
+    radiance()

honeybee_radiance/_extend_honeybee.py

@@ -0,0 +1,93 @@
+# coding=utf-8
+from honeybee.properties import ModelProperties, RoomProperties, FaceProperties, \
+    ShadeProperties, ApertureProperties, DoorProperties, ShadeMeshProperties
+import honeybee.writer.door as door_writer
+import honeybee.writer.aperture as aperture_writer
+import honeybee.writer.shade as shade_writer
+import honeybee.writer.shademesh as shademesh_writer
+import honeybee.writer.face as face_writer
+import honeybee.writer.room as room_writer
+import honeybee.writer.model as model_writer
+
+from .properties.model import ModelRadianceProperties
+from .properties.room import RoomRadianceProperties
+from .properties.face import FaceRadianceProperties
+from .properties.shade import ShadeRadianceProperties
+from .properties.shademesh import ShadeMeshRadianceProperties
+from .properties.aperture import ApertureRadianceProperties
+from .properties.door import DoorRadianceProperties
+from .writer import model_to_rad_folder, model_to_rad, room_to_rad, face_to_rad, \
+    shade_to_rad, shade_mesh_to_rad, aperture_to_rad, door_to_rad
+
+
+# set a hidden radiance attribute on each core geometry Property class to None
+# define methods to produce radiance property instances on each Property instance
+ModelProperties._radiance = None
+RoomProperties._radiance = None
+FaceProperties._radiance = None
+ShadeProperties._radiance = None
+ApertureProperties._radiance = None
+DoorProperties._radiance = None
+ShadeMeshProperties._radiance = None
+
+
+def model_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = ModelRadianceProperties(self.host)
+    return self._radiance
+
+
+def room_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = RoomRadianceProperties(self.host)
+    return self._radiance
+
+
+def face_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = FaceRadianceProperties(self.host)
+    return self._radiance
+
+
+def shade_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = ShadeRadianceProperties(self.host)
+    return self._radiance
+
+
+def aperture_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = ApertureRadianceProperties(self.host)
+    return self._radiance
+
+
+def door_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = DoorRadianceProperties(self.host)
+    return self._radiance
+
+
+def shade_mesh_radiance_properties(self):
+    if self._radiance is None:
+        self._radiance = ShadeMeshRadianceProperties(self.host)
+    return self._radiance
+
+
+# add radiance property methods to the Properties classes
+ModelProperties.radiance = property(model_radiance_properties)
+RoomProperties.radiance = property(room_radiance_properties)
+FaceProperties.radiance = property(face_radiance_properties)
+ShadeProperties.radiance = property(shade_radiance_properties)
+ApertureProperties.radiance = property(aperture_radiance_properties)
+DoorProperties.radiance = property(door_radiance_properties)
+ShadeMeshProperties.radiance = property(shade_mesh_radiance_properties)
+
+# add energy writer to rad
+model_writer.rad_folder = model_to_rad_folder
+model_writer.rad = model_to_rad
+room_writer.rad = room_to_rad
+face_writer.rad = face_to_rad
+shade_writer.rad = shade_to_rad
+aperture_writer.rad = aperture_to_rad
+door_writer.rad = door_to_rad
+shademesh_writer.rad = shade_mesh_to_rad

honeybee_radiance/cli/__init__.py

@@ -0,0 +1,88 @@
+"""honeybee-radiance commands which will be added to honeybee command line interface."""
+import click
+import sys
+import logging
+import json
+
+from honeybee.cli import main
+from ..config import folders
+from .setconfig import set_config
+from .edit import edit
+from .translate import translate
+from .lib import lib
+from .sky import sky
+from .grid import grid
+from .view import view
+from .sunpath import sunpath
+from .octree import octree
+from .raytrace import raytrace
+from .rpict import rpict
+from .dc import dc
+from .viewfactor import view_factor
+from .postprocess import post_process
+from .mtx import mtxop
+from .multiphase import multi_phase
+from .glare import dcglare
+from .schedule import schedule
+from .study import study
+from .modifier import modifier
+
+
+_logger = logging.getLogger(__name__)
+
+
+# command group for all radiance extension commands.
+@click.group(help='honeybee radiance commands.')
+@click.version_option()
+def radiance():
+    pass
+
+
+@radiance.command('config')
+@click.option('--output-file', help='Optional file to output the JSON string of '
+              'the config object. By default, it will be printed out to stdout',
+              type=click.File('w'), default='-', show_default=True)
+def config(output_file):
+    """Get a JSON object with all configuration information"""
+    try:
+        config_dict = {
+            'radiance_path': folders.radiance_path,
+            'radbin_path': folders.radbin_path,
+            'radlib_path': folders.radlib_path,
+            'radiance_version': folders.radiance_version_str,
+            'standards_data_folder': folders.standards_data_folder,
+            'modifier_lib': folders.modifier_lib,
+            'modifierset_lib': folders.modifierset_lib
+        }
+        output_file.write(json.dumps(config_dict, indent=4))
+    except Exception as e:
+        _logger.exception('Failed to retrieve configurations.\n{}'.format(e))
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+# add sub-commands to radiance
+radiance.add_command(set_config, name='set-config')
+radiance.add_command(edit)
+radiance.add_command(translate)
+radiance.add_command(lib)
+radiance.add_command(sky)
+radiance.add_command(grid)
+radiance.add_command(view)
+radiance.add_command(sunpath)
+radiance.add_command(octree)
+radiance.add_command(raytrace)
+radiance.add_command(rpict)
+radiance.add_command(dc)
+radiance.add_command(view_factor)
+radiance.add_command(post_process, name='post-process')
+radiance.add_command(mtxop)
+radiance.add_command(multi_phase)
+radiance.add_command(dcglare)
+radiance.add_command(schedule)
+radiance.add_command(study)
+radiance.add_command(modifier)
+
+# add radiance sub-commands to honeybee CLI
+main.add_command(radiance)

honeybee_radiance/cli/dc.py

@@ -0,0 +1,400 @@
+"""honeybee radiance daylight coefficient / contribution commands."""
+import click
+import sys
+import os
+import logging
+
+from honeybee_radiance.config import folders
+from honeybee_radiance_command.rcontrib import Rcontrib, RcontribOptions
+from honeybee_radiance_command._command_util import run_command
+from honeybee_radiance_command.rfluxmtx import Rfluxmtx, RfluxmtxOptions
+from honeybee_radiance.reader import sensor_count_from_file
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to run daylight contribution/ coefficient calculations in Radiance.')
+def dc():
+    pass
+
+
+@dc.command('scontrib')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'modifiers', type=click.Path(exists=True, file_okay=True)
+)
+@click.option(
+    '--sensor-count', type=click.INT, show_default=True,
+    help='Number of sensors in sensor grid file. Number of sensors will be parsed form'
+    ' the sensor file if not provided.'
+)
+@click.option(
+    '--rad-params', show_default=True, help='Radiance parameters.'
+)
+@click.option(
+    '--rad-params-locked', show_default=True, help='Protected Radiance parameters. '
+    'These values will overwrite user input rad parameters.'
+)
+@click.option(
+    '--output', '-o', show_default=True, help='Path to output file (.mtx or .dc). If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--coeff/--value', is_flag=True, default=True, help='Switch between daylight '
+    ' coefficient and values. Default is coeff for calculating coefficient.'
+)
+@click.option(
+    '--conversion', help='conversion as a string which will be passed to rmtxop -c. '
+    'This option is useful to post-process the results from 3 RGB components into one '
+    'as part of this command.'
+)
+@click.option(
+    '--multiply-by', help='A value to multiply by all the results. This input is '
+    'helpful to adjust the values for runs with different timesteps if required. '
+    'This value will be multiplied by the values provided by conversion input.',
+    type=click.FLOAT, default=1
+)
+@click.option(
+    '--output-format', help='Output type for converted results. Valid inputs are a, f '
+    'and d for ASCII, float or double. If conversion is not provided you can change the '
+    'output type using rad-params options.', type=click.Choice(['a', 'f', 'd']),
+    default='a', show_default=True, show_choices=True
+)
+@click.option(
+    '--order-by-sensor/--order-by-datetime', is_flag=True, default=True,
+    show_default=True, help='An option to change how results are ordered in each row. '
+    'By default each row are the results for a sensor during all the sun-up hours. '
+    'You can change that by using --order-by-datetime flag to get the results for a '
+    'single datetime in each row.'
+)
+@click.option(
+    '--keep-header/--remove-header', ' /-h-', is_flag=True, default=True,
+    help='A flag to keep or remove the header from the output file.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rcontrib_command_with_postprocess(
+        octree, sensor_grid, modifiers, sensor_count, rad_params, rad_params_locked,
+        output, coeff, conversion, multiply_by, output_format, order_by_sensor,
+        keep_header, dry_run
+):
+    """Run rcontrib command for an input octree and a sensor grid.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor-grid: Path to sensor grid file.
+        modifiers: Path to modifiers file.
+    """
+    try:
+        # first check to be sure there are sun-up hours; if so, write a blank file
+        if os.path.getsize(modifiers) == 0:
+            if output is not None:
+                with open(output, 'w') as wf:
+                    wf.write('')
+            return
+
+        options = RcontribOptions()
+        # parse input radiance parameters
+        if rad_params:
+            options.update_from_string(rad_params.strip())
+        # overwrite input values with protected ones
+        if rad_params_locked:
+            options.update_from_string(rad_params_locked.strip())
+
+        if not sensor_count:
+            sensor_count = sensor_count_from_file(sensor_grid)
+
+        if coeff:
+            options.update_from_string('-aa 0.0 -V- -y {}'.format(sensor_count))
+        else:
+            options.update_from_string('-aa 0.0 -V+ -y {}'.format(sensor_count))
+
+        modifiers = os.path.relpath(modifiers)
+        if modifiers.startswith('..'):
+            pass
+        else:
+            modifiers = f'./{modifiers}'
+        cmd = 'rcontrib {options} -M {modifiers} {octree} < {sensor_grid}'.format(
+            options=options.to_radiance(),
+            modifiers=modifiers, octree=octree, sensor_grid=sensor_grid)
+        cmd = cmd.replace("\\", "/")
+
+        if conversion and conversion.strip():
+            if multiply_by != 1:
+                conversion = ' '.join(str(c * multiply_by) for c in conversion.split())
+            # pass the values to rmtxop
+            cmd = '{command} | rmtxop -f{output_format} - -c {conversion}'.format(
+                command=cmd, output_format=output_format, conversion=conversion
+            )
+        elif multiply_by != 1:
+            conversion = '{mult} {mult} {mult}'.format(mult=multiply_by)
+            cmd = '{command} | rmtxop -f{output_format} - -c {conversion}'.format(
+                command=cmd, output_format=output_format, conversion=conversion
+            )
+
+        if order_by_sensor is not True:
+            cmd = cmd + ' -t '
+        if not keep_header:
+            cmd = cmd + ' | getinfo - '
+        if output:
+            cmd = '{command} > {output}'.format(command=cmd, output=output)
+
+        if dry_run:
+            click.echo(cmd)
+        else:
+            # rcontrib.run(env=env)
+            run_command(cmd, env=folders.env)
+    except Exception:
+        _logger.exception('Failed to run ray-tracing command.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@dc.command('scoeff')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sky-dome', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sky-mtx', type=click.Path(exists=True, file_okay=True)
+)
+@click.option(
+    '--sensor-count', type=click.INT, show_default=True,
+    help='Number of sensors in sensor grid file. Number of sensors will be parsed form'
+    ' the sensor file if not provided.'
+)
+@click.option(
+    '--rad-params', show_default=True, help='Radiance parameters.'
+)
+@click.option(
+    '--rad-params-locked', show_default=True, help='Protected Radiance parameters. '
+    'These values will overwrite user input rad parameters.'
+)
+@click.option(
+    '--output', '-o', show_default=True, help='Path to output file (.mtx or .dc). If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--conversion', help='conversion as a string which will be passed to rmtxop -c. '
+    'This option is useful to post-process the results from 3 RGB components into one '
+    'as part of this command.'
+)
+@click.option(
+    '--multiply-by', help='A value to multiply by all the results. This input is '
+    'helpful to adjust the values for runs with different timesteps if required. '
+    'This value will be multiplied by the values provided by converstion input.',
+    type=click.FLOAT, default=1
+)
+@click.option(
+    '--output-format', help='Output type for converted results. Valid inputs are a, f '
+    'and d for ASCII, float or double.', type=click.Choice(['a', 'f', 'd']), default='f',
+    show_default=True, show_choices=True
+)
+@click.option(
+    '--order-by-sensor/--order-by-datetime', is_flag=True, default=True,
+    show_default=True, help='An option to change how results are ordered in each row. '
+    'By default each row are the results for a sensor during all the sun-up hours. '
+    'You can change that by using --order-by-datetime flag to get the results for a '
+    'single datetime in each row.'
+)
+@click.option(
+    '--keep-header/--remove-header', ' /-h-', is_flag=True, default=True,
+    help='A flag to keep or remove the header from the output file.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rfluxmtx_command_with_postprocess(
+    octree, sensor_grid, sky_dome, sky_mtx, sensor_count, rad_params, rad_params_locked,
+    output, conversion, multiply_by, output_format, order_by_sensor, keep_header, dry_run
+):
+    """Run rfluxmtx command and pass the results to rmtxop.
+
+    octree: Path to octree file.
+
+    sensor-grid: Path to sensor grid file.
+
+    sky-dome: Path to sky dome for coefficient calculation.
+
+    sky-mtx: Path to sky matrix.
+
+    """
+    try:
+        # first check to be sure there are sun-up hours; if so, write a blank file
+        if os.path.getsize(sky_mtx) == 0:
+            if output is not None:
+                with open(output, 'w') as wf:
+                    wf.write('')
+            return
+
+        options = RfluxmtxOptions()
+        # parse input radiance parameters
+        if rad_params:
+            options.update_from_string(rad_params.strip())
+        # overwrite input values with protected ones
+        if rad_params_locked:
+            options.update_from_string(rad_params_locked.strip())
+
+        if not sensor_count:
+            sensor_count = sensor_count_from_file(sensor_grid)
+
+        options.update_from_string('-aa 0.0 -faf -y {}'.format(sensor_count))
+
+        # create command.
+        cmd_template = 'rfluxmtx {rad_params} - "{sky_dome}" -i """{octree}""" < ' \
+            '"{sensors}" | rmtxop -f{output_format} - "{sky_mtx}"'
+
+        if conversion and conversion.strip():
+            if multiply_by != 1:
+                conversion = ' '.join(str(c * multiply_by) for c in conversion.split())
+            cmd_template = cmd_template + ' -c %s' % conversion
+        elif multiply_by != 1:
+            conversion = '{mult} {mult} {mult}'.format(mult=multiply_by)
+            cmd_template = cmd_template + ' -c %s' % conversion
+
+        if not order_by_sensor:
+            cmd_template = cmd_template + ' -t '
+
+        if not keep_header:
+            cmd_template = cmd_template + ' | getinfo - '
+        if output:
+            cmd_template = cmd_template + ' > "{output}"'.format(output=output)
+
+        cmd = cmd_template.format(
+            rad_params=options.to_radiance(), sky_dome=sky_dome, octree=octree,
+            sensors=sensor_grid, output_format=output_format, sky_mtx=sky_mtx
+        )
+
+        if dry_run:
+            click.echo(cmd)
+        else:
+            run_command(cmd, env=folders.env)
+    except Exception:
+        _logger.exception('Failed to run rfluxmtx command.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@dc.command('coeff')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True)
+)
+@click.argument(
+    'sky-dome', type=click.Path(exists=True, file_okay=True)
+)
+@click.option(
+    '--sensor-count', type=click.INT, show_default=True,
+    help='Number of sensors in sensor grid file. Number of sensors will be parsed form'
+    ' the sensor file if not provided.'
+)
+@click.option(
+    '--rad-params', show_default=True, help='Radiance parameters.'
+)
+@click.option(
+    '--rad-params-locked', show_default=True, help='Protected Radiance parameters. '
+    'These values will overwrite user input rad parameters.'
+)
+@click.option(
+    '--output', '-o', show_default=True, help='Path to output file (.mtx or .dc). If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--conversion', help='conversion as a string which will be passed to rmtxop -c. '
+    'This option is useful to post-process the results from 3 RGB components into one '
+    'as part of this command.'
+)
+@click.option(
+    '--input-format', help='Format type for input. Valid inputs are a, f and d for '
+    'ASCII, float or double.', type=click.Choice(['a', 'f', 'd']), default='a',
+    show_default=True, show_choices=True
+)
+@click.option(
+    '--output-format', help='Output type for converted results. Valid inputs are a, f '
+    'and d for ASCII, float or double.', type=click.Choice(['a', 'f', 'd']), default='f',
+    show_default=True, show_choices=True
+)
+@click.option(
+    '--keep-header/--remove-header', ' /-h-', is_flag=True, default=True,
+    help='A flag to keep or remove the header from the output file.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rfluxmtx_command_without_postprocess(
+    octree, sensor_grid, sky_dome, sensor_count, rad_params, rad_params_locked, output,
+    conversion, input_format, output_format, keep_header, dry_run
+):
+    """Run rfluxmtx command without sky matrix.
+
+    This command calculates the coefficient matrix for a sensor grid and sky dome. There
+    is no postprocessing, i.e., no sky matrix.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor-grid: Path to sensor grid file.
+        sky-dome: Path to sky dome for coefficient calculation.
+    """
+    try:
+        options = RfluxmtxOptions()
+        options.fio = input_format + output_format
+        # parse input radiance parameters
+        if rad_params:
+            options.update_from_string(rad_params.strip())
+        # overwrite input values with protected ones
+        if rad_params_locked:
+            options.update_from_string(rad_params_locked.strip())
+
+        if not sensor_count:
+            sensor_count = sensor_count_from_file(sensor_grid)
+
+        options.update_from_string('-aa 0.0 -y {}'.format(sensor_count))
+
+        # create command.
+        cmd_template = 'rfluxmtx {rad_params} - "{sky_dome}" -i """{octree}""" < ' \
+            '"{sensors}"'
+
+        if conversion and conversion.strip():
+            conversion = ' '.join(str(c ) for c in conversion.split())
+            cmd_template = cmd_template + ' | rmtxop - -c %s' % conversion
+
+        if not keep_header:
+            cmd_template = cmd_template + ' | getinfo - '
+        if output:
+            cmd_template = cmd_template + ' > "{output}"'.format(output=output)
+
+        cmd = cmd_template.format(
+            rad_params=options.to_radiance(), sky_dome=sky_dome, octree=octree,
+            sensors=sensor_grid
+        )
+
+        if dry_run:
+            click.echo(cmd)
+        else:
+            run_command(cmd, env=folders.env)
+    except Exception:
+        _logger.exception('Failed to run rfluxmtx command.')
+        sys.exit(1)
+    else:
+        sys.exit(0)