honeybee-radiance-postprocess 0.4.416__py2.py3-none-any.whl → 0.4.418__py2.py3-none-any.whl

honeybee_radiance_postprocess/cli/__init__.py

@@ -1,6 +1,5 @@
 """Modules for post-processing simulation outputs."""
 import click
-import logging
 
 from honeybee.cli import main
 from .grid import grid
@@ -8,9 +7,7 @@ from .mtxop import mtxop
 from .postprocess import post_process
 from .schedule import schedule
 from .translate import translate
-
-
-_logger = logging.getLogger(__name__)
+from .viewfactor import view_factor
 
 
 # command group for all postprocess extension commands.
@@ -26,6 +23,7 @@ postprocess.add_command(mtxop)
 postprocess.add_command(post_process, name='post-process')
 postprocess.add_command(schedule)
 postprocess.add_command(translate)
+postprocess.add_command(view_factor)
 
 # add postprocess sub-commands to honeybee CLI
 main.add_command(postprocess)

honeybee_radiance_postprocess/cli/abnt.py

@@ -62,10 +62,21 @@ def abnt_nbr_15575(
             a requirement that the sensor grids have Meshes.
     """
     def find_surrounding_points(x, y, x_coords, y_coords):
-        x1 = np.max(x_coords[x_coords <= x]) if np.any(x_coords <= x) else x_coords[0]
-        x2 = np.min(x_coords[x_coords > x]) if np.any(x_coords > x) else x_coords[-1]
-        y1 = np.max(y_coords[y_coords <= y]) if np.any(y_coords <= y) else y_coords[0]
-        y2 = np.min(y_coords[y_coords > y]) if np.any(y_coords > y) else y_coords[-1]
+        """Find the four nearest points and return the minimum and maximum
+        x and y values."""
+        # calculate Euclidean distances
+        distances = np.sqrt((x_coords - x)**2 + (y_coords - y)**2)
+        # get the four nearest points
+        if len(distances) < 4:
+            # if the grid for some reason has less than four sensors
+            nearest_indices = np.argsort(distances)[:len(distances)]
+        else:
+            nearest_indices = np.argsort(distances)[:4]
+        x_values = x_coords[nearest_indices]
+        y_values = y_coords[nearest_indices]
+        x1, x2 = min(x_values), max(x_values)
+        y1, y2 = min(y_values), max(y_values)
+
         return x1, x2, y1, y2
 
     def get_value(x, y, x_coords, y_coords, values):
@@ -73,7 +84,7 @@ def abnt_nbr_15575(
         index = np.where((np.abs(x_coords - x) <= tolerance) & (np.abs(y_coords - y) <= tolerance))
         return values[index][0]
 
-    def perform_interpolation(x, y, x_coords, y_coords, pit_values):
+    def perform_interpolation(x, y, x_coords, y_caoords, pit_values):
         x1, x2, y1, y2 = find_surrounding_points(x, y, x_coords, y_coords)
 
         # extract the illuminance values at the surrounding points
@@ -153,7 +164,6 @@ def abnt_nbr_15575(
 
                 x_coords = sensor_points[:, 0]
                 y_coords = sensor_points[:, 1]
-
                 room = hb_model.rooms_by_identifier([sensor_grid.room_identifier])[0]
 
                 pof_sensor_grid = \

honeybee_radiance_postprocess/cli/viewfactor.py

@@ -0,0 +1,150 @@
+"""Commands to compute view factors to geometry."""
+import click
+import os
+import sys
+import logging
+import math
+import numpy as np
+
+from honeybee_radiance.config import folders
+
+from honeybee_radiance_command.rcontrib import Rcontrib, RcontribOptions
+from honeybee_radiance_command._command_util import run_command
+
+from ladybug.futil import preparedir
+
+from honeybee_radiance_postprocess.reader import binary_to_array
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands to compute view factors to geometry.')
+def view_factor():
+    pass
+
+
+@view_factor.command('contrib')
+@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.argument(
+    'modifiers', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.option(
+    '--ray-count', type=click.INT, default=6, show_default=True,
+    help='The number of rays to be equally distributed over a sphere to compute '
+    'the view factor for each of the input sensors.'
+)
+@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(
+    '--folder', default='.', help='Output folder into which the modifier and '
+    'octree files will be written.'
+)
+@click.option(
+    '--name', default='view_factor', help='File name of the view factor file.'
+)
+def rcontrib_command_with_view_postprocess(
+        octree, sensor_grid, modifiers, ray_count, rad_params, rad_params_locked,
+        folder, name
+):
+    """Run rcontrib to get spherical view factors from a sensor grid.
+
+    This command is similar to the one in honeybee-radiance, but the
+    post-processing is using NumPy.
+
+    \b
+    Args:
+        octree: Path to octree file.
+        sensor-grid: Path to sensor grid file.
+        modifiers: Path to modifiers file.
+    """
+    try:
+        # create the directory if it's not there
+        if not os.path.isdir(folder):
+            preparedir(folder)
+
+        # generate the ray vectors to be used in the view factor calculation
+        if ray_count == 6:
+            rays = ((1, 0, 0), (0, 1, 0), (0, 0, 1), (-1, 0, 0), (0, -1, 0), (0, 0, -1))
+        else:
+            rays = _fibonacci_spiral(ray_count)
+        ray_str = [' {} {} {}\n'.format(*ray) for ray in rays]
+
+        # create a new .pts file with the view vectors
+        ray_file = os.path.abspath(os.path.join(folder, '{}.pts'.format(name)))
+        total_rays = 0
+        with open(sensor_grid) as sg_file:
+            with open(ray_file, 'w') as r_file:
+                for line in sg_file:
+                    for ray in ray_str:
+                        try:
+                            r_file.write(' '.join(line.split()[:3]) + ray)
+                            total_rays += 1
+                        except Exception:
+                            pass  # we are at the end of the file
+
+        # set up the Rcontrib options
+        options = RcontribOptions()
+        if rad_params:  # parse input radiance parameters
+            options.update_from_string(rad_params.strip())
+        if rad_params_locked:  # overwrite input values with protected ones
+            options.update_from_string(rad_params_locked.strip())
+        # overwrite specific options that would otherwise break the command
+        options.M = modifiers
+        options.update_from_string('-I -V- -y {}'.format(total_rays))
+
+        # create the rcontrib command and run it
+        mtx_file = os.path.abspath(os.path.join(folder, '{}.mtx'.format(name)))
+        rcontrib = Rcontrib(options=options, octree=octree, sensors=ray_file)
+        cmd = rcontrib.to_radiance().replace('\\', '/')
+        cmd = '{} | rmtxop -ff - -c .333 .333 .334 > "{}"'.format(cmd, mtx_file.replace('\\', '/'))
+        run_command(cmd, env=folders.env)
+
+        # load the resulting matrix and process the results into view factors
+        array = binary_to_array(mtx_file)
+        view_fac_mtx = []
+        for i in range(0, len(array), ray_count):
+            sens_chunk = array[i:i+ray_count]
+            s_facs = np.sum(sens_chunk, axis=0) / (math.pi * ray_count)
+            view_fac_mtx.append(s_facs)
+
+        np.save(os.path.join(folder, '{}'.format(name)), view_fac_mtx)
+
+    except Exception:
+        _logger.exception('Failed to compute view factor contributions.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def _fibonacci_spiral(point_count=24):
+    """Get points distributed uniformly across a unit spherical surface.
+
+    Args:
+        point_count: Integer for the number of points to be distributed.
+
+    Returns:
+        List of tuple, each with 3 values representing the XYZ coordinates of
+        the points that were generated.
+    """
+    points = []
+    phi = math.pi * (3. - math.sqrt(5.))
+
+    for i in range(point_count):
+        y = 1 - (i / float(point_count - 1)) * 2
+        radius = math.sqrt(1 - y * y)
+        theta = phi * i
+        x = math.cos(theta) * radius
+        z = math.sin(theta) * radius
+        points.append((x, y, z))
+
+    return points

{honeybee_radiance_postprocess-0.4.416.dist-info → honeybee_radiance_postprocess-0.4.418.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.416
+Version: 0.4.418
 Summary: Postprocessing of Radiance results and matrices
 Home-page: https://github.com/ladybug-tools/honeybee-radiance-postprocess
 Author: Ladybug Tools

{honeybee_radiance_postprocess-0.4.416.dist-info → honeybee_radiance_postprocess-0.4.418.dist-info}/RECORD

@@ -14,8 +14,8 @@ honeybee_radiance_postprocess/reader.py,sha256=6myKzfGC1pO8zPixg1kKrKjPihHabTKUh
 honeybee_radiance_postprocess/type_hints.py,sha256=4R0kZgacQrqzoh8Tq7f8MVzUDzynV-C_jlh80UV6GPE,1122
 honeybee_radiance_postprocess/util.py,sha256=-J5k1dhvyYJkb42jvTS_xxtokfGbmcucVPXdMWU1jUk,5098
 honeybee_radiance_postprocess/vis_metadata.py,sha256=7ywIgdiuNKcctxifhpy7-Q2oaSX2ngQBeA0Kh7q1Gg0,1780
-honeybee_radiance_postprocess/cli/__init__.py,sha256=4RkpR91GPXWatDE4I_27ce-N4FwolQoO6WO7H24DMXE,777
-honeybee_radiance_postprocess/cli/abnt.py,sha256=kenlfNCRDJTMBCtTraFHwYcI3eSwtt22t_cJzw_IWp8,12462
+honeybee_radiance_postprocess/cli/__init__.py,sha256=PVfwkuPFl4TnvQt8ovVm01JK0Alon81BaY-0tshAXyg,795
+honeybee_radiance_postprocess/cli/abnt.py,sha256=IEJdGi4fkLD75C833CVpk5WimMm7PVMGYV3QBNgVOGE,12785
 honeybee_radiance_postprocess/cli/grid.py,sha256=6peLEAPVe-iw05_wdRpFruZLqO8myvC-_QT5W1q5sk8,10677
 honeybee_radiance_postprocess/cli/leed.py,sha256=QBR6AMJJWuZ0TevyMi2tXCWMLdS-ZSqtVTZDgqxwa7M,3112
 honeybee_radiance_postprocess/cli/mtxop.py,sha256=UZJnjNpPjDmShy1-Mxos4H2vTUqk_yP3ZyaC1_LLFeI,5015
@@ -24,13 +24,14 @@ honeybee_radiance_postprocess/cli/schedule.py,sha256=6uIy98Co4zm-ZRcELo4Lfx_aN3l
 honeybee_radiance_postprocess/cli/translate.py,sha256=18zkcGeRZALJ5Z82NEB3XZ-iEX2cHyneobGWV-IXWE0,6789
 honeybee_radiance_postprocess/cli/two_phase.py,sha256=xA6ayPv26DM5fuMkLhBMYGklf_j5ymowmncwJGXRgo8,7034
 honeybee_radiance_postprocess/cli/util.py,sha256=Be9cGmYhcV2W37ma6SgQPCWCpWLLLlroxRYN_l58kY0,4077
+honeybee_radiance_postprocess/cli/viewfactor.py,sha256=kU36YRzLya5PReYREjTfw3zOcWKHYZjVlVclyuR7Cqk,5245
 honeybee_radiance_postprocess/results/__init__.py,sha256=1agBQbfT4Tf8KqSZzlfKYX8MeZryY4jJ1KB4HWqaDDk,182
 honeybee_radiance_postprocess/results/annual_daylight.py,sha256=ohysFt4OWlWUn_IvM6pjmiQcRTq_x5b998Iv0pw8AEQ,34964
 honeybee_radiance_postprocess/results/annual_irradiance.py,sha256=5zwrr4MNeHUebbSRpSBbscPOZUs2AHmYCQfIIbdYImY,8298
 honeybee_radiance_postprocess/results/results.py,sha256=GwyjIYljaCShx1b6NlYUBcU_gHhckmLcCMNrQ6HVDdE,53507
-honeybee_radiance_postprocess-0.4.416.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_radiance_postprocess-0.4.416.dist-info/METADATA,sha256=SwBB3ghQY0fMC5Z5QVeIkfuxzI8v2hKvmGPa1s2u2BI,2245
-honeybee_radiance_postprocess-0.4.416.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
-honeybee_radiance_postprocess-0.4.416.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
-honeybee_radiance_postprocess-0.4.416.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
-honeybee_radiance_postprocess-0.4.416.dist-info/RECORD,,
+honeybee_radiance_postprocess-0.4.418.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_radiance_postprocess-0.4.418.dist-info/METADATA,sha256=EaZPDjNDUhsc3qgyqLJI1oLDJd010yi0yY0x3egJcdg,2245
+honeybee_radiance_postprocess-0.4.418.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
+honeybee_radiance_postprocess-0.4.418.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
+honeybee_radiance_postprocess-0.4.418.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
+honeybee_radiance_postprocess-0.4.418.dist-info/RECORD,,