honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/cli/raytrace.py

@@ -0,0 +1,219 @@
+"""honeybee radiance ray-tracing command commands."""
+import click
+import sys
+import logging
+import os
+
+from honeybee_radiance.config import folders
+from honeybee_radiance_command.rtrace import Rtrace, RtraceOptions
+from honeybee_radiance_command.rcalc import Rcalc
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to run ray-tracing in Radiance.')
+def raytrace():
+    pass
+
+
+@raytrace.command('rtrace')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@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. If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rtrace_command(
+        octree, sensor_grid, rad_params, rad_params_locked, output, dry_run):
+    """Run rtrace command for an input octree and a sensor grid.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor_grid: Path to sensor grid file.
+    """
+    try:
+        options = RtraceOptions()
+        # 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())
+
+        # create command.
+        rtrace = Rtrace(
+            options=options, output=output, octree=octree, sensors=sensor_grid
+        )
+
+        if dry_run:
+            click.echo(rtrace)
+        else:
+            env = None
+            if folders.env != {}:
+                env = folders.env
+            env = dict(os.environ, **env) if env else None
+            rtrace.run(env=env)
+    except Exception:
+        _logger.exception('Failed to run ray-tracing command.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@raytrace.command('daylight-factor')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@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(
+    '--sky-illum', '-i', default=100000, show_default=True, help='Sky illuminance value'
+    '. The post-processed results will be divided by this number.'
+)
+@click.option(
+    '--output', '-o', show_default=True, help='Path to output file. If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rtrace_with_df_post_process(
+        octree, sensor_grid, rad_params, rad_params_locked, sky_illum, output, dry_run):
+    """Run rtrace command with rcalc post-processing for daylight factor studies.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor_grid: Path to sensor grid file.
+    """
+    try:
+        options = RtraceOptions()
+        # 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())
+
+        # create command.
+        rtrace = Rtrace(options=options, octree=octree, sensors=sensor_grid)
+
+        # add rcalc post-procing
+        rcalc = Rcalc(output=output)
+        rcalc.options.e = '$1=(0.265*$1+0.67*$2+0.065*$3)*17900/{}'.format(sky_illum)
+        rtrace.pipe_to = rcalc
+
+        if dry_run:
+            click.echo(rtrace)
+        else:
+            env = None
+            if folders.env != {}:
+                env = folders.env
+            env = dict(os.environ, **env) if env else None
+            rtrace.run(env=env)
+    except Exception:
+        _logger.exception('Failed to run daylight-factor ray-tracing.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@raytrace.command('point-in-time')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.argument(
+    'sensor-grid', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@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(
+    '--metric', '-m', default='illuminance', show_default=True,
+    help='Text for the type of metric to be output from the calculation. Choose from: '
+    'illuminance, irradiance, luminance, radiance.'
+)
+@click.option(
+    '--output', '-o', show_default=True, help='Path to output file. If a relative path'
+    ' is provided it should be relative to project folder.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rtrace_with_pit_post_process(
+        octree, sensor_grid, rad_params, rad_params_locked, metric, output, dry_run):
+    """Run rtrace command with rcalc post-processing for point-in-time studies.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor_grid: Path to sensor grid file.
+    """
+    try:
+        options = RtraceOptions()
+        # 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())
+        # overwrite the -I attribute depending on the metric to be calculated
+        if metric in ('illuminance', 'irradiance'):
+            options.I = True
+        elif metric in ('luminance', 'radiance'):
+            options.I = False
+        else:
+            raise ValueError('Metric "{}" is not recognized.'.format(metric))
+
+        # create command.
+        rtrace = Rtrace(options=options, octree=octree, sensors=sensor_grid)
+
+        # add rcalc post-procing
+        rcalc = Rcalc(output=output)
+        rcalc.options.e = '$1=(0.265*$1+0.67*$2+0.065*$3)*179' if metric in \
+            ('illuminance', 'luminance') else '$1=(0.265*$1+0.67*$2+0.065*$3)'
+        rtrace.pipe_to = rcalc
+
+        if dry_run:
+            click.echo(rtrace)
+        else:
+            env = None
+            if folders.env != {}:
+                env = folders.env
+            env = dict(os.environ, **env) if env else None
+            rtrace.run(env=env)
+    except Exception:
+        _logger.exception('Failed to run point-in-time ray-tracing.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance/cli/rpict.py

@@ -0,0 +1,125 @@
+"""honeybee radiance rpict command."""
+import click
+import sys
+import logging
+import os
+import shutil
+
+from honeybee_radiance.config import folders
+from honeybee_radiance_command.rpict import Rpict, RpictOptions
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to run rpict in Radiance.')
+def rpict():
+    pass
+
+
+@rpict.command('rpict')
+@click.argument(
+    'octree', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.argument(
+    'view', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.option(
+    '--rad-params', help='Radiance parameters.'
+)
+@click.option(
+    '--rad-params-locked', help='Protected Radiance parameters. These values will '
+    'overwrite user input rad parameters.'
+)
+@click.option(
+    '--metric', '-m', default='luminance', show_default=True,
+    help='Text for the type of metric to be output from the calculation. Choose from: '
+    'illuminance, irradiance, luminance, radiance.'
+)
+@click.option(
+    '--resolution', '-r', default=None, type=int, show_default=True,
+    help='An integer for the maximum dimension of the image in pixels (either '
+    'width/height depending on the input view angle and type). This will '
+    'overwrite the -x and -y option in any input radiance parameters if specified. '
+    'The default value for Radiance is 512 pixels.'
+)
+@click.option(
+    '--scale-factor', '-s', default=1, type=float, show_default=True,
+    help='A number that will be multiplied by the input resolution to scale the '
+    'dimensions of the output image. This is useful in workflows if one plans to '
+    're-scale the image after the ray tracing calculation to improve anti-aliasing.'
+)
+@click.option(
+    '--output', '-o', help='Path to output file. If a relative path is provided it '
+    'should be relative to project folder.'
+)
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def rpict_command(
+        octree, view, rad_params, rad_params_locked, metric, resolution, scale_factor,
+        output, dry_run):
+    """Run rpict command for an input octree and a view file.
+
+    Note that, if an ambient cache file (.amb) is found next to the view file,
+    and it is determined to be valid (with a non-zero size) it will be
+    automatically used within the rpict command.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        view: Path to view file.
+
+    """
+    try:
+        options = RpictOptions()
+        # 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())
+        # overwrite the -i attribute depending on the metric to be calculated
+        if metric in ('illuminance', 'irradiance'):
+            options.i = True
+        elif metric in ('luminance', 'radiance'):
+            options.i = False
+        else:
+            raise ValueError('Metric "{}" is not recognized.'.format(metric))
+        # overwrite the -x and -y attribute depending on the input resolution
+        if resolution:
+            options.x = int(resolution * scale_factor)
+            options.y = int(resolution * scale_factor)
+        # sense wether there is an ambient cache file next to the view
+        for base_file in os.listdir(os.path.dirname(view)):
+            if base_file.endswith('.amb'):
+                full_amb_path = os.path.join(os.path.dirname(view), base_file)
+                if os.stat(full_amb_path).st_size != 0:
+                    options.af = os.path.join(os.path.dirname(view), base_file)
+                    break
+
+        # write the metric type into the view name such that it's in the HDR header
+        metric_view = os.path.basename(view).replace('.vf', '_{}.vf'.format(metric))
+        full_metric_view = os.path.join(os.path.dirname(view), metric_view)
+        shutil.copyfile(view, full_metric_view)
+
+        # create command.
+        rpict = Rpict(
+            options=options, output=output, octree=octree, view=full_metric_view
+        )
+
+        if dry_run:
+            click.echo(rpict)
+        else:
+            env = None
+            if folders.env != {}:
+                env = folders.env
+            env = dict(os.environ, **env) if env else None
+            rpict.run(env=env)
+        os.remove(full_metric_view)
+    except Exception:
+        _logger.exception('Failed to run rpict command.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance/cli/schedule.py

@@ -0,0 +1,56 @@
+"""honeybee radiance schedule command."""
+import click
+import sys
+import logging
+import os
+
+from ladybug.epw import EPW
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to create and modify schedules.')
+def schedule():
+    pass
+
+
+@schedule.command('epw-to-daylight-hours')
+@click.argument(
+    'epw', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.option('--folder', '-f', help='Output folder.', default='.', show_default=True)
+@click.option(
+    '--name', '-n', help='Output file name for schedule.',
+    type=click.STRING, default='daylight_hours', show_default=True
+)
+def epw_to_daylight_hours(epw, folder, name):
+    """Convert EPW to EN 17037 schedule as a CSV file.
+
+    This command generates a valid schedule for EN 17037, also known as daylight hours.
+    Rather than a typical occupancy schedule, the daylight hours is half the year with
+    the largest quantity of daylight. This is generated by sorting the EPW file by
+    diffuse horizontal illuminance.
+
+    \b
+    Args:
+        epw: Path to epw file.
+    """
+    try:
+        epw_data = EPW(epw)
+        diffuse_horizontal_illuminance = epw_data.diffuse_horizontal_illuminance
+        _illuminance, indices = diffuse_horizontal_illuminance.highest_values(4380)
+        values = ['1' if i in indices else '0' for i in range(8760)]
+
+        if not os.path.isdir(folder):
+            os.makedirs(folder)
+
+        # write csv
+        file_path = os.path.join(folder, '%s.csv' % name)
+        with open(file_path, 'w') as fp:
+            fp.write('\n'.join(values))
+
+    except Exception:
+        _logger.exception('Failed to generate daylight hours schedule.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance/cli/setconfig.py

@@ -0,0 +1,63 @@
+"""Commands to set honeybee-radiance configurations."""
+import click
+import sys
+import logging
+import json
+
+from honeybee_radiance.config import folders
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to set honeybee-radiance configurations.')
+def set_config():
+    pass
+
+
+@set_config.command('radiance-path')
+@click.argument('folder-path', required=False, type=click.Path(
+    exists=True, file_okay=False, dir_okay=True, resolve_path=True))
+def radiance_path(folder_path):
+    """Set the radiance-path configuration variable.
+
+    \b
+    Args:
+        folder_path: Path to a folder to be set as the radiance-path.
+            If unspecified, the radiance-path will be set back to
+            the default.
+    """
+    _set_config_variable(folder_path, 'radiance_path')
+
+
+@set_config.command('standards-data-folder')
+@click.argument('folder-path', required=False, type=click.Path(
+    exists=True, file_okay=False, dir_okay=True, resolve_path=True))
+def standards_data_folder(folder_path):
+    """Set the standards-data-folder configuration variable.
+
+    \b
+    Args:
+        folder_path: Path to a folder to be set as the standards-data-folder.
+            If unspecified, the standards-data-folder will be set back to
+            the default.
+    """
+    _set_config_variable(folder_path, 'standards_data_folder')
+
+
+def _set_config_variable(folder_path, variable_name):
+    var_cli_name = variable_name.replace('_', '-')
+    try:
+        config_file = folders.config_file
+        with open(config_file) as inf:
+            data = json.load(inf)
+        data[variable_name] = folder_path if folder_path is not None else ''
+        with open(config_file, 'w') as fp:
+            json.dump(data, fp, indent=4)
+        msg_end = 'reset to default' if folder_path is None \
+            else 'set to: {}'.format(folder_path)
+        print('{} successfully {}.'.format(var_cli_name, msg_end))
+    except Exception as e:
+        _logger.exception('Failed to set {}.\n{}'.format(var_cli_name, e))
+        sys.exit(1)
+    else:
+        sys.exit(0)