honeybee-radiance-postprocess 0.4.555__py3-none-any.whl

honeybee_radiance_postprocess/cli/schedule.py

@@ -0,0 +1,103 @@
+"""honeybee radiance postprocess schedule commands."""
+import click
+import sys
+import logging
+
+from ..results.annual_daylight import AnnualDaylight
+from ..dynamic import DynamicSchedule
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to create schedules for Radiance results.')
+def schedule():
+    pass
+
+
+@schedule.command('control-schedules')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--base-schedule-file', '-bs', help='Path to a schedule file. A list of '
+    '8760 fractional values for the lighting schedule representing the usage '
+    'of lights without any daylight controls. The values of this schedule '
+    'will be multiplied by the hourly dimming fraction to yield the output '
+    'lighting schedules. If None, a schedule from 9AM to 5PM on weekdays will '
+    'be used.',
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--states', '-st', help='A JSON file with a dictionary of states. If states '
+    'are not provided the default states will be used for any aperture groups.',
+    default=None, show_default=True,
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--grids-filter', '-gf', help='A pattern to filter the grids.', default='*',
+    show_default=True
+)
+@click.option(
+    '--ill-setpoint',
+    help='A number for the illuminance setpoint in lux beyond which electric '
+    'lights are dimmed if there is sufficient daylight.', default=300,
+    type=float, show_default=True
+)
+@click.option(
+    '--min-power-in',
+    help='A number between 0 and 1 for the the lowest power the lighting '
+    'system can dim down to, expressed as a fraction of maximum input power.',
+    default=0.3, type=float, show_default=True
+)
+@click.option(
+    '--min-light-out',
+    help='A number between 0 and 1 the lowest lighting output the lighting '
+    'system can dim down to, expressed as a fraction of maximum light output. '
+    'Note that setting this to 1 means lights are not dimmed at all until the '
+    'illuminance setpoint is reached.', default=0.2, type=float,
+    show_default=True
+)
+@click.option(
+    '--off-at-min', is_flag=True, default=False, help='Boolean to '
+    'note whether lights should switch off completely when they get to the '
+    'minimum power input.'
+)
+@click.option(
+    '--sub-folder', '-sf', help='Optional relative path for subfolder to '
+    'write output schedule files.', default='schedules'
+)
+def control_schedules(
+    folder, states, grids_filter, base_schedule_file, ill_setpoint,
+    min_power_in, min_light_out, off_at_min, sub_folder
+):
+    """Generate electric lighting schedules from annual daylight results.
+
+    \b
+    Args:
+        folder: Results folder. This folder is an output folder of annual daylight
+            recipe. Folder should include grids_info.json and sun-up-hours.txt. The
+            command uses the list in grids_info.json to find the result files for each
+            sensor grid.
+    """
+    try:
+        if base_schedule_file:
+            with open(base_schedule_file) as base_schedule:
+                base_schedule = [float(h) for h in base_schedule.readlines()]
+        else:
+            base_schedule = None
+
+        if states:
+            states = DynamicSchedule.from_json(states)
+
+        results = AnnualDaylight(folder)
+        results.daylight_control_schedules_to_folder(
+            sub_folder, states=states, grids_filter=grids_filter,
+            base_schedule=base_schedule, ill_setpoint=ill_setpoint,
+            min_power_in=min_power_in, min_light_out=min_light_out,
+            off_at_min=off_at_min)
+    except Exception:
+        _logger.exception('Failed to generate control schedules.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/cli/translate.py

@@ -0,0 +1,216 @@
+"""Commands to translate objects."""
+import sys
+import logging
+from pathlib import Path
+import shutil
+import click
+import json
+try:
+    import cupy as np
+    is_gpu = True
+except ImportError:
+    is_gpu = False
+    import numpy as np
+
+from ..reader import binary_to_array
+from ..util import get_delimiter
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to translate objects.')
+def translate():
+    pass
+
+
+@translate.command('npy-to-txt')
+@click.argument(
+    'npy-file', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--name', '-n', help='Output file name.', default='output', show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--extension', '-ext', help='Output file extension', default='txt', show_default=True
+)
+@click.option(
+    '--output-format', '-fmt', help='Output format for each element in the array',
+    default='%.7e', show_default=True
+)
+@click.option(
+    '--delimiter', '-d', help='Delimiter in the text file.', default='\t',
+    type=click.Choice(['\t', ' ', ',', ';', 'tab', 'space', 'comma', 'semicolon'])
+)
+def npy_to_txt(npy_file, name, output_folder, extension, output_format, delimiter):
+    """Convert a npy file to text file.
+
+    This command reads a NumPy array from a npy file and saves it as readable file. The
+    converted file is tab separated.
+
+    \b
+    Args:
+        npy-file: Path to npy file.
+    """
+    try:
+        delimiter = get_delimiter(delimiter)
+        array = np.load(npy_file)
+        output = Path(output_folder, f'{name}.{extension}')
+        output.parent.mkdir(parents=True, exist_ok=True)
+        np.savetxt(output, array, fmt=output_format, delimiter=delimiter)
+
+    except Exception:
+        _logger.exception('Converting npy file to text file failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@translate.command('txt-to-npy')
+@click.argument(
+    'txt-file', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--name', '-n', help='Output file name.', default='output', show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--delimiter', '-d', help='Delimiter in the text file.', default='\t',
+    type=click.Choice(['\t', ' ', ',', ';', 'tab', 'space', 'comma', 'semicolon'])
+)
+def txt_to_npy(txt_file, name, output_folder, delimiter):
+    """Convert a text file to npy file.
+
+    This command reads a separated text file and saves it as a NumPy file. As
+    an example the input file could be the annual illuminance values.
+
+    \b
+    Args:
+        txt-file: Path to text file.
+    """
+    try:
+        delimiter = get_delimiter(delimiter)
+        array = np.genfromtxt(txt_file, dtype=np.float32, delimiter=delimiter)
+        output = Path(output_folder, name)
+        output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(output, array)
+
+    except Exception:
+        _logger.exception('Converting text file to npy file failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@translate.command('binary-to-npy')
+@click.argument(
+    'mtx-file', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--conversion', help='Conversion as a string. This option is useful to post-process '
+    'the results from 3 RGB components into one as part of this command.'
+)
+@click.option(
+    '--name', '-n', help='Output file name.', default='output', show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def binary_to_npy(mtx_file, conversion, name, output_folder):
+    """Convert a binary Radiance file to a npy file.
+
+    This command reads a binary Radiance matrix file and saves it as a NumPy file.
+
+    \b
+    Args:
+        mtx-file: Path to binary Radiance file.
+    """
+    try:
+        array = binary_to_array(mtx_file)
+        if conversion:
+            conversion = list(map(float, conversion.split(' ')))
+            conversion = np.array(conversion, dtype=np.float32)
+            array = np.dot(array, conversion)
+        output = Path(output_folder, name)
+        output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(output, array)
+
+    except Exception:
+        _logger.exception('Converting binary Radiance file to npy file failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@translate.command('annual-daylight-npy-to-ill')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder. If not provided the output '
+    'folder will be created in the same directory as the results folder. The '
+    'new folder will be called results_ill.', default=None,
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def annual_daylight_npy_to_ill(folder, output_folder):
+    """Convert an annual daylight results folder to older version.
+
+    This command reads an annual daylight results folder with results saved as
+    npy files (NumPy), and converts the npy files to text files in the old
+    results folder format.
+
+    \b
+    Args:
+        folder: Results folder. This folder is an output folder of annual
+            daylight recipe. Folder should include grids_info.json and
+            sun-up-hours.txt.
+    """
+    try:
+        folder = Path(folder)
+        static_ill_folder = folder.joinpath('__static_apertures__/default/total')
+        if not static_ill_folder.exists():
+            raise FileNotFoundError(
+                'No results were found for static apertures in the results '
+                'folder.')
+        grids_info_file = folder.joinpath('grids_info.json')
+        if not grids_info_file.exists():
+            raise FileNotFoundError(
+                'The file grids_info.json was not found in the results folder.')
+        sun_up_hours_file = folder.joinpath('sun-up-hours.txt')
+        if not sun_up_hours_file.exists():
+            raise FileNotFoundError(
+                'The file sun-up-hours.txt was not found in the results folder.')
+
+        if output_folder is None:
+            output_folder = folder.parent.joinpath('results_ill')
+        else:
+            output_folder = Path(output_folder)
+        output_folder.mkdir(parents=True, exist_ok=True)
+
+        with open(grids_info_file) as json_file:
+            grids_info = json.load(json_file)
+
+        for grid_info in grids_info:
+            full_id = grid_info['full_id']
+            npy_file = static_ill_folder.joinpath(f'{full_id}.npy')
+
+            array = np.load(npy_file)
+            output = Path(output_folder, full_id + '.ill')
+            np.savetxt(output, array, fmt='%.7e', delimiter='\t')
+
+        # copy grids_info and sun-up-hours
+        shutil.copy(grids_info_file, output_folder.joinpath('grids_info.json'))
+        shutil.copy(sun_up_hours_file, output_folder.joinpath('sun-up-hours.txt'))
+    except Exception:
+        _logger.exception('Converting annual daylight results folder failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/cli/two_phase.py

@@ -0,0 +1,252 @@
+"""Commands to work with two phase Radiance matrices using NumPy."""
+import sys
+import logging
+from pathlib import Path
+import click
+try:
+    import cupy as np
+    is_gpu = True
+except ImportError:
+    is_gpu = False
+    import numpy as np
+
+from ..reader import binary_to_array, ascii_to_array
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to work with two phase Radiance matrices using NumPy.')
+def two_phase():
+    pass
+
+
+@two_phase.command('rgb-to-illuminance')
+@click.argument(
+    'total-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.argument(
+    'direct-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.argument(
+    'direct-sunlight-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--binary/--ascii', is_flag=True, default=True, help='Switch between binary '
+    'and ascii input matrices. Default is binary.'
+)
+@click.option(
+    '--float32/--float16', is_flag=True, default=True, help='Switch between float32 '
+    'and float16 output matrices. Default is float32.'
+)
+@click.option(
+    '--total-name', '-n', help='Total output file name.', default='total',
+    show_default=True
+)
+@click.option(
+    '--direct-name', '-n', help='Direct output file name.', default='direct',
+    show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def rgb_to_illuminance(
+    total_mtx, direct_mtx, direct_sunlight_mtx, binary, float32, total_name,
+    direct_name, output_folder
+    ):
+    """Process results of two phase simulations (total, direct, direct sunlight).
+
+    The function will replace the direct illuminance with the direct sunlight
+    illuminance: total - direct + direct_sunlight.
+
+    The function has two output files. One for the illuminance of the above
+    calculation, and one for the direct sunlight illuminance. In both cases
+    the conversion from RGB to illuminance is executed.
+
+    \b
+    Args:
+        total-mtx: Path to total matrix.
+        direct-mtx: Path to direct matrix.
+        direct-sunlight-mtx: Path to direct sunlight matrix.
+    """
+    try:
+        if binary:
+            total = binary_to_array(total_mtx)
+            direct = binary_to_array(direct_mtx)
+            direct_sunlight = binary_to_array(direct_sunlight_mtx)
+        else:
+            total = ascii_to_array(total_mtx)
+            direct = ascii_to_array(direct_mtx)
+            direct_sunlight = ascii_to_array(direct_sunlight_mtx)
+
+        data = total - direct + direct_sunlight
+
+        conversion = np.array([47.4, 119.9, 11.6], dtype=np.float32)
+        total_illuminance = np.dot(data, conversion)
+        direct_sunlight_illuminance = np.dot(direct_sunlight, conversion)
+
+        if not float32:
+            total_illuminance = np.minimum(
+                total_illuminance, np.finfo(np.float16).max).astype(
+                np.float16)
+            direct_sunlight_illuminance = np.minimum(
+                direct_sunlight_illuminance, np.finfo(np.float16).max).astype(
+                np.float16)
+
+        # save total illuminance
+        total_output = Path(output_folder, total_name)
+        total_output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(total_output, total_illuminance)
+
+        # save direct sunlight illuminance
+        direct_output = Path(output_folder, direct_name)
+        direct_output.parent.mkdir(parents=True, exist_ok=True)
+
+        np.save(direct_output, direct_sunlight_illuminance)
+
+    except Exception:
+        _logger.exception('Processing annual results failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@two_phase.command('rgb-to-illuminance-file')
+@click.argument(
+    'mtx-file', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--binary/--ascii', is_flag=True, default=True, help='Switch between binary '
+    'and ascii input matrices. Default is binary.'
+)
+@click.option(
+    '--float32/--float16', is_flag=True, default=True, help='Switch between float32 '
+    'and float16 output matrices. Default is float32.'
+)
+@click.option(
+    '--name', '-n', help='Name of output file.', default='illuminance',
+    show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def rgb_to_illuminance_file(
+    mtx_file, binary, float32, name, output_folder
+    ):
+    """Convert a RGB Radiance matrix to illuminance and save the array as a
+    NumPy file.
+
+    \b
+    Args:
+        mtx-file: Path to matrix file to convert.
+    """
+    try:
+        if binary:
+            mtx = binary_to_array(mtx_file)
+        else:
+            mtx = ascii_to_array(mtx_file)
+
+        conversion = np.array([47.4, 119.9, 11.6], dtype=np.float32)
+        total_illuminance = np.dot(mtx, conversion)
+
+        if not float32:
+            total_illuminance = np.minimum(
+                total_illuminance, np.finfo(np.float16).max).astype(
+                np.float16)
+
+        # save total illuminance
+        total_output = Path(output_folder, name)
+        total_output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(total_output, total_illuminance)
+
+    except Exception:
+        _logger.exception('Processing annual results failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@two_phase.command('add-remove-sky-matrix')
+@click.argument(
+    'total-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.argument(
+    'direct-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.argument(
+    'direct-sunlight-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--binary/--ascii', is_flag=True, default=True, help='Switch between binary '
+    'and ascii input matrices. Default is binary.'
+)
+@click.option(
+    '--float32/--float16', is_flag=True, default=True, help='Switch between float32 '
+    'and float16 output matrices. Default is float32.'
+)
+@click.option(
+    '--total-name', '-n', help='Total output file name.', default='total',
+    show_default=True
+)
+@click.option(
+    '--direct-name', '-n', help='Direct output file name.', default='direct',
+    show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def add_remove_sky_matrix(
+    total_mtx, direct_mtx, direct_sunlight_mtx, binary, float32, total_name,
+    direct_name, output_folder
+    ):
+    """Process results of two phase simulations (total, direct, direct sunlight).
+
+    The function will replace the direct values with the direct sunlight
+    values: total - direct + direct_sunlight.
+
+    The function has two output files. One for the results of the above
+    calculation, and one for the direct sunlight values.
+
+    \b
+    Args:
+        total-mtx: Path to total matrix.
+        direct-mtx: Path to direct matrix.
+        direct-sunlight-mtx: Path to direct sunlight matrix.
+    """
+    try:
+        if binary:
+            total = binary_to_array(total_mtx)
+            direct = binary_to_array(direct_mtx)
+            direct_sunlight = binary_to_array(direct_sunlight_mtx)
+        else:
+            total = ascii_to_array(total_mtx)
+            direct = ascii_to_array(direct_mtx)
+            direct_sunlight = ascii_to_array(direct_sunlight_mtx)
+
+        data = total - direct + direct_sunlight
+
+        if not float32:
+            data = np.minimum(
+                data, np.finfo(np.float16).max).astype(
+                np.float16)
+            direct_sunlight = np.minimum(
+                direct_sunlight, np.finfo(np.float16).max).astype(
+                np.float16)
+
+        # save total values
+        total_output = Path(output_folder, total_name)
+        total_output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(total_output, data)
+
+        # save direct values
+        direct_output = Path(output_folder, direct_name)
+        direct_output.parent.mkdir(parents=True, exist_ok=True)
+        np.save(direct_output, direct_sunlight)
+
+    except Exception:
+        _logger.exception('Processing annual results failed.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/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 rmtxopt 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