honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/cli/sunpath.py

@@ -0,0 +1,331 @@
+"""honeybee radiance sunpath commands."""
+import click
+import sys
+
+from honeybee_radiance.config import folders
+from honeybee_radiance_command.gendaymtx import Gendaymtx, GendaymtxOptions
+from honeybee_radiance_command._command_util import run_command
+
+from honeybee_radiance.lightsource.sunpath import Sunpath
+from ladybug.location import Location
+from ladybug.wea import Wea
+import logging
+import json
+import os
+
+from .util import get_hoys
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to generate Radiance Sunpath.')
+def sunpath():
+    pass
+
+
+@sunpath.command('location')
+@click.option(
+    '--lat', default=0, type=float, show_default=True,
+    help='The latitude of the location in degrees. Values must be between -90 and 90.'
+    ' Default is set to the equator.')
+@click.option(
+    '--lon', default=0, type=float, show_default=True,
+    help='The longitude of the location in degrees')
+@click.option(
+    '--tz', default=0, type=float, show_default=True,
+    help='A number representing the time zone of the location you are constructing. This'
+    ' can improve the accuracy of the resulting sun plot.  The time zone should follow'
+    ' the epw convention and should be between -12 and +12, where 0 is at Greenwich, UK,'
+    ' positive values are to the East of Greenwich and negative values are to the West.')
+@click.option(
+    '--north', default=0, type=float, show_default=True,
+    help='Angle to north (0-360). 90 is west and 270 is east')
+@click.option(
+    '--start-date', default='JAN-01', show_default=True,
+    help='Start date as MMM-DD (e.g JUL-21). Start date itself will also be included.')
+@click.option(
+    '--start-time', default='00:00', show_default=True,
+    help='Start time as HH:MM (e.g 14:10). Start time itself will also be included.')
+@click.option(
+    '--end-date', default='DEC-31', show_default=True,
+    help='End date as MMM-DD (e.g JUL-21). End date itself will also be included.')
+@click.option(
+    '--end-time', default='23:00', show_default=True,
+    help='End time as HH:MM (e.g 18:30). End time itself will also be included.')
+@click.option(
+    '--timestep', default=1, type=int, show_default=True,
+    help='An optional integer to set the number of time steps per hour. Default is 1'
+    ' for one value per hour.')
+@click.option('--leap-year/--full-year', ' /-fy',
+              help='Flag for whether to use a leap year.')
+@click.option('--folder', default='.', help='Output folder.')
+@click.option('--name', default='sunpath', help='File name.')
+@click.option(
+    '--log-file', help='Optional log file to output the name of the newly created'
+    ' modifier files. By default the list will be printed out to stdout',
+    type=click.File('w'), default='-')
+@click.option(
+    '--reverse-vectors', is_flag=True,
+    help='Reverse sun vectors to go from ground to sky.')
+def sunpath_from_location(
+    lat, lon, tz, north, folder, name, log_file, start_date, start_time, end_date,
+        end_time, timestep, leap_year, reverse_vectors):
+    """Generate a non climate-based sunpath for a location.
+
+    This command also generates a mod file which includes all the modifiers in sunpath.
+    mod file is usually used with rcontrib command to indicate the list of modifiers.
+    Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files
+    will be broken down into multiple files if number of modifiers is more than 10000
+    modifiers.
+    """
+    location = Location()
+    location.latitude = lat
+    location.longitude = lon
+    location.time_zone = tz
+    try:
+        sp = Sunpath(location, north)
+        hoys = get_hoys(start_date, start_time, end_date, end_time, timestep, leap_year)
+        sp_files = sp.to_file(
+            folder, name, hoys=hoys, leap_year=leap_year, reverse_vectors=reverse_vectors
+        )
+
+        files = [
+            {'path': os.path.relpath(path, folder), 'full_path': path}
+            for path in sp_files['suns']
+        ]
+
+        log_file.write(json.dumps(files))
+    except Exception:
+        _logger.exception('Failed to generate sunpath.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@sunpath.command('wea')
+@click.argument('wea', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--north', default=0, type=float, show_default=True,
+    help='Angle to north (0-360). 90 is west and 270 is east')
+@click.option(
+    '--timestep', default=1, type=int, show_default=True,
+    help='An integer to set the number of time steps per hour in the wea. Default is 1'
+    ' for one value per hour.')
+@click.option(
+    '--leap-year/--full-year', ' /-fy',
+    help='Flag for whether input wea is for a leap year.'
+)
+@click.option('--folder', default='.', help='Output folder.')
+@click.option('--name', default='sunpath', help='File name.')
+@click.option(
+    '--log-file', help='Optional log file to output the name of the newly'
+    ' created modifier files. By default the list will be printed out to stdout',
+    type=click.File('w'), default='-')
+@click.option(
+    '--reverse-vectors', is_flag=True,
+    help='Reverse sun vectors to go from ground to sky.')
+def sunpath_from_wea(wea, north, folder, name, log_file, timestep, leap_year,
+                     reverse_vectors):
+    """Generate a climate-based sunpath from a Wea file.
+
+    This command also generates a mod file which includes all the modifiers in sunpath.
+    mod file is usually used with rcontrib command to indicate the list of modifiers.
+    Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files
+    will be broken down into multiple files if number of modifiers is more than 10000
+    modifiers.
+
+    wea: Path to a wea file.
+    """
+    try:
+        wea = Wea.from_file(wea, timestep=timestep, is_leap_year=leap_year)
+        sp = Sunpath(wea.location, north)
+        hoys = wea.hoys
+        sp_files = sp.to_file(
+            folder, name, wea=wea, hoys=hoys, leap_year=leap_year,
+            reverse_vectors=reverse_vectors
+        )
+
+        files = [
+            {'path': os.path.relpath(path, folder), 'full_path': path}
+            for path in sp_files['suns']
+        ]
+
+        log_file.write(json.dumps(files))
+    except Exception:
+        _logger.exception('Failed to generate sunpath.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@sunpath.command('radiance')
+@click.argument('wea', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--north', default=0, type=float, show_default=True,
+    help='Angle to north (0-360). 90 is west and 270 is east')
+@click.option('--folder', type=click.Path(
+    exists=False, file_okay=False, dir_okay=True, resolve_path=True), default='.',
+    help='Output folder.')
+@click.option('--name', default='sunpath', help='File name.')
+@click.option(
+    '--visible/--solar', is_flag=True, default=True, help='A flag to indicate the '
+    'output type. Visible is equal to -O0 and solar is -O1 in gendaymtx options. '
+    'Default: visible.'
+    )
+@click.option(
+    '--log-file', help='Optional log file to output the name of the newly'
+    ' created modifier files. By default the list will be printed out to stdout',
+    type=click.File('w'), default='-')
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def sunpath_from_wea_rad(wea, north, folder, name, visible, log_file, dry_run):
+    """Generate a climate-based sunpath from a Wea file using radiance's gendaymtx.
+
+    This command also generates a mod file which includes all the modifiers in sunpath.
+    mod file is usually used with rcontrib command to indicate the list of modifiers.
+    Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files
+    will be broken down into multiple files if number of modifiers is more than 10000
+    modifiers.
+
+    \b
+    Args:
+        wea: Path to a wea file. This can also be an epw file.
+
+    """
+    try:
+        if not os.path.exists(folder):
+            os.makedirs(folder)
+        with open(wea) as inf:
+            first_word = inf.read(5)
+        is_wea = True if first_word == 'place' else False
+        if not is_wea:
+            _wea_file = os.path.join(os.path.dirname(wea), 'epw_to_wea.wea')
+            wea = Wea.from_epw_file(wea).write(_wea_file)
+        opt = GendaymtxOptions()
+        opt.n = True
+        opt.D = os.path.join(folder, name + '.mtx').replace('\\', '//')
+        opt.M = os.path.join(folder, name + '.mod').replace('\\', '//')
+        opt.r = north
+        opt.O = '0' if visible else '1'
+
+        cmd = Gendaymtx(wea=wea, options=opt)
+
+        if dry_run:
+            print(cmd.to_radiance())
+            sys.exit(0)
+
+        run_command(cmd.to_radiance(), env=folders.env)
+        files = [
+            {'path': os.path.relpath(path, folder), 'full_path': path}
+            for path in (opt.D.value, opt.M.value)
+        ]
+
+        log_file.write(json.dumps(files))
+    except Exception:
+        _logger.exception('Failed to generate sunpath.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@sunpath.command('epw')
+@click.argument('epw', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--north', default=0, type=float, show_default=True,
+    help='Angle to north (0-360). 90 is west and 270 is east')
+@click.option(
+    '--start-date', default='JAN-01', show_default=True,
+    help='Start date as MMM-DD (e.g JUL-21). Start date itself will also be included.')
+@click.option(
+    '--start-time', default='00:00', show_default=True,
+    help='Start time as HH:MM (e.g 14:10). Start time itself will also be included.')
+@click.option(
+    '--end-date', default='DEC-31', show_default=True,
+    help='End date as MMM-DD (e.g JUL-21). End date itself will also be included.')
+@click.option(
+    '--end-time', default='23:00', show_default=True,
+    help='End time as HH:MM (e.g 18:30). End time itself will also be included.')
+@click.option(
+    '--timestep', default=1, type=int, show_default=True,
+    help='An optional integer to set the number of time steps per hour. Default is 1'
+    ' for one value per hour.')
+@click.option(
+    '--leap-year/--full-year', ' /-fy',
+    help='Flag for whether input epw is for a leap year.'
+)
+@click.option('--folder', default='.', help='Output folder.')
+@click.option('--name', default='sunpath', help='File name.', type=str)
+@click.option(
+    '--log-file', help='Optional log file to output the name of the newly'
+    ' created modifier files. By default the list will be printed out to stdout',
+    type=click.File('w'), default='-')
+@click.option(
+    '--reverse-vectors', is_flag=True,
+    help='Reverse sun vectors to go from ground to sky.')
+def sunpath_from_epw(
+        epw, north, folder, name, log_file, start_date, start_time, end_date, end_time,
+        timestep, leap_year, reverse_vectors):
+    """Generate a climate-based sunpath from an epw weather file.
+
+    This command also generates a mod file which includes all the modifiers in sunpath.
+    mod file is usually used with rcontrib command to indicate the list of modifiers.
+    Since rcontrib command has a hard limit of 10,000 modifiers in a single run the files
+    will be broken down into multiple files if number of modifiers is more than 10000
+    modifiers.
+
+    epw: Path to a epw file.
+    """
+    try:
+        wea = Wea.from_epw_file(epw)
+        sp = Sunpath(wea.location, north)
+        hoys = get_hoys(start_date, start_time, end_date, end_time, timestep, leap_year)
+        sp_files = sp.to_file(
+            folder, name, wea=wea, hoys=hoys, leap_year=leap_year,
+            reverse_vectors=reverse_vectors
+        )
+
+        files = [
+            {'path': os.path.relpath(path, folder), 'full_path': path}
+            for path in sp_files['suns']
+        ]
+
+        log_file.write(json.dumps(files))
+    except Exception:
+        _logger.exception('Failed to generate sunpath.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@sunpath.command('parse-hours')
+@click.argument('suns', type=click.File(mode='r'))
+@click.option('--timestep', default=1, type=int, show_default=True,
+              help='This input is not used and is deprecated.')
+@click.option('--leap-year/--full-year', ' /-fy',
+              help='This input is not used and is deprecated.')
+@click.option('--folder', default='.', help='Output folder.')
+@click.option('--name', default='hours.txt', help='Output file name.')
+def parse_hours_from_suns(suns, timestep, leap_year, folder, name):
+    """Parse hours of the year from a suns modifier file generated by Radiance's
+    gendaymtx.
+
+    suns: Path to a suns modifiers file.
+    """
+    try:
+        hours = []
+        for line in suns:
+            hours.append(int(line.split('solar')[1]) / 60)
+        # write the new file to hoys
+        with open(os.path.join(folder, name), 'w') as hf:
+            for h in hours:
+                hf.write('%s\n' % h)
+    except Exception:
+        _logger.exception('Failed to parse the hours.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance/cli/threephase.py

@@ -0,0 +1,255 @@
+import os
+
+import click
+import sys
+import logging
+import json
+
+from honeybee_radiance_command.dctimestep import Dctimestep, DctimestepOptions
+from honeybee_radiance_command.rmtxop import Rmtxop, RmtxopOptions
+from honeybee_radiance_command.getinfo import Getinfo
+from honeybee_radiance.config import folders
+from honeybee_radiance_command._command_util import run_command
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to do matrix operations for three-phase.')
+def three_phase():
+    pass
+
+
+@three_phase.command('multiplication')
+@click.argument(
+    'sky-vector', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'view-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    't-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'daylight-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'output-matrix',
+    type=click.Path(
+        exists=False, file_okay=True, dir_okay=False, resolve_path=True
+    ),
+)
+@click.option(
+    '--options', help='a string that will be passed to dctimestep for setting options '
+    'such as output file format (-o), input data format(-i) etc.')
+@click.option(
+    '--dry-run', is_flag=True, default=False, show_default=True,
+    help='A flag to show the command without running it.'
+)
+def three_phase_calc(sky_vector, view_matrix, t_matrix, daylight_matrix, output_matrix,
+                     options, dry_run):
+    """Matrix multiplication for view matrix, transmission matrix, daylight matrix and
+    sky matrix."""
+
+    try:
+        base_options = DctimestepOptions()
+        options = options.strip() if options else None
+        if options:
+            base_options.update_from_string(options)
+
+        cmd = Dctimestep.three_phase_calc(sky_vector=sky_vector, view_matrix=view_matrix,
+                                          t_matrix=t_matrix,
+                                          daylight_matrix=daylight_matrix,
+                                          output=output_matrix, options=base_options)
+        if dry_run:
+            click.echo(cmd)
+        else:
+            run_command(cmd.to_radiance(), env=folders.env)
+    except OSError:
+        os.system(cmd.to_radiance())
+    except Exception:
+        _logger.exception('Failed to run matrix multiplication calculations with '
+                          'dctimestep')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@three_phase.command('rmtxop')
+@click.argument(
+    'view-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    't-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'daylight-matrix', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'sky-vector', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'output-matrix',
+    type=click.Path(
+        exists=False, file_okay=True, dir_okay=False, resolve_path=True
+    ),
+)
+@click.option(
+    '--output-format', help='Output format for output matrix. Valid inputs are a, f, d '
+    'and c for ASCII, float, double or RGBE colors. If conversion is not provided you '
+    'can change the output type using rad-params options.',
+    type=click.Choice(['a', 'f', 'd', 'c']), default='a', show_default=True,
+    show_choices=True
+)
+@click.option(
+    '--illuminance/--raw', is_flag=True, default=True, show_default=True,
+    help='A flag to convert the result to illuminance.'
+)
+@click.option(
+    '--remove-header/--keep-header', 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 three_phase_rmtxop(
+    view_matrix, t_matrix, daylight_matrix, sky_vector, output_matrix, output_format,
+    illuminance, remove_header, dry_run
+):
+    """Matrix multiplication for view matrix, transmission matrix, daylight matrix and
+    sky matrix."""
+
+    try:
+        options = RmtxopOptions()
+        options.f = output_format
+        matrices = [view_matrix, t_matrix, daylight_matrix, sky_vector]
+
+        if illuminance:
+            # rmtxop concatenation
+            calc = Rmtxop(matrices=matrices)
+
+            cmd = Rmtxop(options=options)
+            cmd.transforms = [['47.4', '119.9', '11.6']]
+            cmd.matrices = calc
+        else:
+            cmd = Rmtxop(options=options, matrices=matrices)
+
+        if remove_header:
+            getinfo = Getinfo.remove_header(output=output_matrix)
+            cmd.pipe_to = getinfo
+        else:
+            cmd.output = output_matrix
+
+        if dry_run:
+            click.echo(cmd)
+        else:
+            run_command(cmd.to_radiance(), env=folders.env)
+    except OSError:
+        os.system(cmd.to_radiance())
+    except Exception:
+        _logger.exception(
+            'Failed to run matrix multiplication calculations with rmtxop')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@three_phase.command('combinations')
+@click.argument(
+    'sender-info', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'receiver-info', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'states_info', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--folder',
+    help='Path to target folder. The command will create two JSON files in this folder.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True),
+    default='.', show_default=True
+)
+@click.option(
+    '--combinations-name', '-cn', help='Output file name for 3 phase multiplication '
+    'combinations.', type=click.STRING, default='3phase_multiplication_info',
+    show_default=True
+)
+@click.option(
+    '--result-mapper-name', '-rn', help='Output file name for results mapper file.',
+    type=click.STRING, default='3phase_results_info', show_default=True
+)
+def three_phase_combinations(
+    sender_info, receiver_info, states_info, folder, combinations_name,
+    result_mapper_name
+):
+    """Matrix multiplication for view matrix, transmission matrix, daylight matrix and
+    sky matrix.
+
+    \b
+    args:
+        sender_info: A JSON file that includes the information for senders. This file
+            is created as an output of the daylight matrix grouping command.
+        receiver_info: A JSON file that includes the information for receivers. This
+            file is written to model/receiver folder.
+        states_info: A JSON file that includes the state information for all the
+            aperture groups. This file is created under model/aperture_groups.
+
+    """
+    def _read_json_content(json_file):
+        with open(json_file) as inf:
+            return json.loads(inf.read())
+    try:
+        rec_data = _read_json_content(receiver_info)
+        send_data = _read_json_content(sender_info)
+        states = _read_json_content(states_info)
+
+        dmtx_info = {}
+
+        grid_mapper = {}
+        for grid in rec_data:
+            grid_mapper[grid['full_id']] = {}
+            for apt in grid['aperture_groups']:
+                for group in send_data:
+                    if apt in group['aperture_groups']:
+                        dmtx_info[apt] = group['identifier']
+                        break
+                else:
+                    # this should never happen for a valid radiance folder
+                    raise ValueError('Unrecognizable aperture group: %s' % apt)
+
+                grid_mapper[grid['full_id']][apt] = \
+                    [s['identifier'] for s in states[apt]]
+
+        # create all the possible combinations
+        # TODO: find a more generic approach to created the names. Using white_glow
+        # is assuming that we will never change the modifier.
+        matrix_combinations = []
+        for grid in rec_data:
+            for apt in grid['aperture_groups']:
+                vmtx = '%s..white_glow_%s.vtmx' % (grid['identifier'], apt)
+                dmtx = '%s.dmtx' % dmtx_info[apt]
+                for info in states[apt]:
+                    matrix_combinations.append(
+                        dict(
+                            # create an identifier from the mix of grid and state
+                            identifier='%s..%s' % (
+                                grid['full_id'], info['identifier']
+                            ),
+                            light_path=apt,
+                            grid_id=grid['full_id'],
+                            state_id=info['identifier'],
+                            tmtx=info['tmtx'],
+                            vmtx=vmtx,
+                            dmtx=dmtx
+                        )
+                    )
+
+        # write the files to folder
+        if not os.path.isdir(folder):
+            os.mkdir(folder)
+
+        comb_file = os.path.join(folder, '%s.json' % combinations_name)
+        res_file = os.path.join(folder, '%s.json' % result_mapper_name)
+
+        with open(comb_file, 'w') as outf:
+            json.dump(matrix_combinations, outf, indent=2)
+
+        with open(res_file, 'w') as outf:
+            json.dump(grid_mapper, outf, indent=2)
+
+    except Exception:
+        _logger.exception(
+            'Failed to calculate the mapper file for 3 phase studies.')
+        sys.exit(1)
+    else:
+        sys.exit(0)