honeybee-radiance-postprocess 0.4.380__py2.py3-none-any.whl → 0.4.382__py2.py3-none-any.whl

honeybee_radiance_postprocess/cli/abnt.py

@@ -0,0 +1,173 @@
+"""Commands for ABNT NBR post-processing."""
+import json
+import sys
+import logging
+from pathlib import Path
+import click
+import numpy as np
+
+from honeybee.model import Model
+
+from ..vis_metadata import _abnt_nbr_15575_daylight_levels_vis_metadata
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands for ABNT NBR (Brazil) post-processing of Radiance results.')
+def abnt():
+    pass
+
+
+@abnt.command('abnt-nbr-15575')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.argument('model-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--sub-folder', '-sf', help='Relative path for subfolder to write output '
+    'files.', default='abnt_nbr_15575', type=click.Path(
+    exists=False, file_okay=False, dir_okay=True, resolve_path=True, path_type=Path)
+)
+def abnt_nbr_15575(
+    folder, model_file, sub_folder
+):
+    """Calculate metrics for ABNT NBR 15575.
+
+    \b
+    Args:
+        folder: Simulation folder for a ABNT NBR 15575 simulation. It should
+            contain four sub-folder of complete point-in-time illuminance
+            simulations labeled "4_930AM", "4_330PM", "10_930AM", and "10_330PM".
+            These sub-folder should each have results folder that include a
+            grids_info.json and .res files with illuminance values for each
+            sensor.
+        model-file: A Honeybee Model file that was used in the simulations. This
+            file is used to extract the center points of the sensor grids. It is
+            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]
+        return x1, x2, y1, y2
+
+    def get_value(x, y, x_coords, y_coords, values):
+        index = np.where((x_coords == x) & (y_coords == y))
+        return values[index][0]
+
+    def perform_interpolation(x, y, x_coords, y_coords, pit_values):
+        x1, x2, y1, y2 = find_surrounding_points(x, y, x_coords, y_coords)
+
+        # extract the illuminance values at the surrounding points
+        f_Q11 = get_value(x1, y1, x_coords, y_coords, pit_values) # bottom-left
+        f_Q21 = get_value(x2, y1, x_coords, y_coords, pit_values) # bottom-right
+        f_Q12 = get_value(x1, y2, x_coords, y_coords, pit_values) # top-left
+        f_Q22 = get_value(x2, y2, x_coords, y_coords, pit_values) # top-right
+
+        # edge cases
+        if x == x1 and y == y1:
+            f_xy = f_Q11
+        elif x == x2 and y == y1:
+            f_xy = f_Q21
+        elif x == x1 and y == y2:
+            f_xy = f_Q12
+        elif x == x2 and y == y2:
+            f_xy = f_Q22
+        elif x1 == x2:
+            # linear interpolation in y direction
+            f_xy = f_Q11 + (f_Q12 - f_Q11) * (y - y1) / (y2 - y1)
+        elif y1 == y2:
+            # linear interpolation in x direction
+            f_xy = f_Q11 + (f_Q21 - f_Q11) * (x - x1) / (x2 - x1)
+        else:
+            # perform bilinear interpolation
+            f_xy = (f_Q11 * (x2 - x) * (y2 - y) +
+                    f_Q21 * (x - x1) * (y2 - y) +
+                    f_Q12 * (x2 - x) * (y - y1) +
+                    f_Q22 * (x - x1) * (y - y1)) / ((x2 - x1) * (y2 - y1))
+
+        return f_xy
+
+    try:
+        folder = Path(folder)
+        hb_model = Model.from_file(model_file)
+        sensor_grids = hb_model.properties.radiance.sensor_grids
+        sg_full_identifier = {sg.full_identifier: sg for sg in sensor_grids}
+
+        if not sub_folder.exists():
+            sub_folder.mkdir(parents=True, exist_ok=True)
+        illuminance_levels_folder = sub_folder.joinpath('illuminance_levels')
+        if not illuminance_levels_folder.exists():
+            illuminance_levels_folder.mkdir(parents=True, exist_ok=True)
+
+        summary_file = sub_folder.joinpath('abnt_nbr_15575.json')
+        folder_names = ['4_930AM', '4_330PM', '10_930AM', '10_330PM']
+
+        metric_info_dict = _abnt_nbr_15575_daylight_levels_vis_metadata()
+        summary_output = {}
+        for _subfolder in folder_names:
+            res_folder = folder.joinpath(_subfolder, 'results')
+            with open(res_folder.joinpath('grids_info.json')) as data_f:
+                grids_info = json.load(data_f)
+            sub_output = []
+            for grid_info in grids_info:
+                pit_values = \
+                    np.loadtxt(res_folder.joinpath(f'{grid_info["full_id"]}.res'))
+                sensor_grid = sg_full_identifier[grid_info['full_id']]
+                sensor_points = np.array(
+                    [[sensor.pos[0], sensor.pos[1]] for sensor in sensor_grid.sensors])
+
+                x_coords = sensor_points[:, 0]
+                y_coords = sensor_points[:, 1]
+                x, y = sensor_grid.mesh.center.x, sensor_grid.mesh.center.y
+                f_xy = perform_interpolation(x, y, x_coords, y_coords, pit_values)
+
+                if f_xy >= 120:
+                    level = 'Superior'
+                elif f_xy >= 90:
+                    level = 'Intermediário'
+                elif f_xy >= 60: # add check for ground floor (48 lux)
+                    level = 'Mínimo'
+                else:
+                    level = 'Não atende'
+
+                sub_output.append(
+                    {
+                        'nível': level,
+                        'iluminância': f_xy,
+                        'grids_info': grid_info
+                    }
+                )
+
+                conditions = [pit_values >= 120, pit_values >= 90, pit_values >= 60, pit_values < 60]
+                conditions_values = [3, 2, 1, 0]
+                illuminance_level = np.select(conditions, conditions_values)
+
+                ill_level_file = illuminance_levels_folder.joinpath(_subfolder, f'{grid_info["full_id"]}.res')
+                ill_level_file.parent.mkdir(parents=True, exist_ok=True)
+                np.savetxt(ill_level_file, illuminance_level, fmt='%d')
+
+                grids_info_file = illuminance_levels_folder.joinpath(_subfolder, 'grids_info.json')
+                grids_info_file.write_text(json.dumps(grids_info, indent=2))
+
+                vis_data = metric_info_dict[_subfolder]
+                vis_metadata_file = illuminance_levels_folder.joinpath(_subfolder, 'vis_metadata.json')
+                vis_metadata_file.write_text(json.dumps(vis_data, indent=4))
+
+            summary_output[_subfolder] = sub_output
+
+            grids_info_file = folder.joinpath(_subfolder, 'grids_info.json')
+            grids_info_file.write_text(json.dumps(grids_info, indent=2))
+
+        with summary_file.open(mode='w', encoding='utf-8') as output_file:
+            json.dump(summary_output, output_file, indent=4, ensure_ascii=False)
+
+    except Exception:
+        _logger.exception('Failed to calculate ABNT NBR 15575 metrics.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/cli/postprocess.py

@@ -21,6 +21,7 @@ from ..en17037 import en17037_to_folder
 from ..util import filter_array
 from .two_phase import two_phase
 from .leed import leed
+from .abnt import abnt
 from ..helper import model_grid_areas, grid_summary
 
 _logger = logging.getLogger(__name__)
@@ -32,6 +33,7 @@ def post_process():
 
 post_process.add_command(two_phase)
 post_process.add_command(leed)
+post_process.add_command(abnt)
 
 @post_process.command('annual-daylight')
 @click.argument(

honeybee_radiance_postprocess/vis_metadata.py

@@ -0,0 +1,49 @@
+"""Functions for visualization metadata."""
+from ladybug.legend import LegendParameters
+from ladybug.color import Color
+from ladybug.datatype.generic import GenericType
+
+
+def _abnt_nbr_15575_daylight_levels_vis_metadata():
+    """Return visualization metadata for ABNT NBR 15575 Daylight levels."""
+    level_value = {
+        0: 'Não atende',
+        1: 'Mínimo',
+        2: 'Intermediário',
+        3: 'Superior'
+    }
+
+    colors = [Color(255, 198, 143), Color(255, 255, 209), Color(192, 231, 189), Color(83, 169, 206)]
+    illuminance_levels_lpar = \
+        LegendParameters(min=0, max=3, colors=colors, segment_count=4,
+                         title='Illuminance Level')
+    illuminance_levels_lpar.ordinal_dictionary = level_value
+
+    metric_info_dict = {
+        '4_930AM': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('Illuminance April 23rd 9:30am', '').to_dict(),
+            'unit': '',
+            'legend_parameters': illuminance_levels_lpar.to_dict()
+        },
+        '4_330PM': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('Illuminance April 23rd 3:30pm', '').to_dict(),
+            'unit': '',
+            'legend_parameters': illuminance_levels_lpar.to_dict()
+        },
+        '10_930AM': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('Illuminance October 23rd 9:30am', '').to_dict(),
+            'unit': '',
+            'legend_parameters': illuminance_levels_lpar.to_dict()
+        },
+        '10_330PM': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('Illuminance October 23rd 3:30pm', '').to_dict(),
+            'unit': '',
+            'legend_parameters': illuminance_levels_lpar.to_dict()
+        }
+    }
+
+    return metric_info_dict

{honeybee_radiance_postprocess-0.4.380.dist-info → honeybee_radiance_postprocess-0.4.382.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.380
+Version: 0.4.382
 Summary: Postprocessing of Radiance results and matrices
 Home-page: https://github.com/ladybug-tools/honeybee-radiance-postprocess
 Author: Ladybug Tools
@@ -13,7 +13,7 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: honeybee-radiance (==1.66.64)
+Requires-Dist: honeybee-radiance (==1.66.65)
 Requires-Dist: numpy (>=1.21.6)
 
 [![Build Status](https://github.com/ladybug-tools/honeybee-radiance-postprocess/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/honeybee-radiance-postprocess/actions)

{honeybee_radiance_postprocess-0.4.380.dist-info → honeybee_radiance_postprocess-0.4.382.dist-info}/RECORD

@@ -12,11 +12,13 @@ honeybee_radiance_postprocess/metrics.py,sha256=6EHCuXf5jnhh6GglI9mTd0MFpfhfPFoK
 honeybee_radiance_postprocess/reader.py,sha256=6myKzfGC1pO8zPixg1kKrKjPihHabTKUh2t5BlJvij0,2367
 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=darKbj987NXW72GNcTdKQmgqSTpeG39OBwEgbJGEgPw,1820
 honeybee_radiance_postprocess/cli/__init__.py,sha256=4RkpR91GPXWatDE4I_27ce-N4FwolQoO6WO7H24DMXE,777
+honeybee_radiance_postprocess/cli/abnt.py,sha256=UjyOBbyskK7lpJ1PkcxomjO3HeWiIIdcrBDwYeYUPxE,7203
 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
-honeybee_radiance_postprocess/cli/postprocess.py,sha256=vZAw4QFpieUK3Xphi8CvBeuAaVsxxZDO8oqNPmyFn_A,38935
+honeybee_radiance_postprocess/cli/postprocess.py,sha256=JbYPqJqL7iYSyj22yn0g-ImwdTUcMnXI27x0U8gGOsw,38989
 honeybee_radiance_postprocess/cli/schedule.py,sha256=6uIy98Co4zm-ZRcELo4Lfx_aN3lNiqPe-BSimXwt1F8,3877
 honeybee_radiance_postprocess/cli/translate.py,sha256=18zkcGeRZALJ5Z82NEB3XZ-iEX2cHyneobGWV-IXWE0,6789
 honeybee_radiance_postprocess/cli/two_phase.py,sha256=1nZF4jyZ_C7CAfiHCz1UUOEwDaB4yOXr9ga0HIrhOB0,7033
@@ -25,9 +27,9 @@ honeybee_radiance_postprocess/results/__init__.py,sha256=1agBQbfT4Tf8KqSZzlfKYX8
 honeybee_radiance_postprocess/results/annual_daylight.py,sha256=o4Y5kbD3a4X4KRfsbOlWzgrnNKU365GcivM6qQGUGXU,31605
 honeybee_radiance_postprocess/results/annual_irradiance.py,sha256=5zwrr4MNeHUebbSRpSBbscPOZUs2AHmYCQfIIbdYImY,8298
 honeybee_radiance_postprocess/results/results.py,sha256=jkjsxTuvVfBus6tM2UjQE3ZKPooLInWEd2guqO61v9E,53600
-honeybee_radiance_postprocess-0.4.380.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_radiance_postprocess-0.4.380.dist-info/METADATA,sha256=z6gVZQUz6uFQOv2Xg1B_LhHZWpO_KC3VxfCLEJDik_g,2245
-honeybee_radiance_postprocess-0.4.380.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
-honeybee_radiance_postprocess-0.4.380.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
-honeybee_radiance_postprocess-0.4.380.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
-honeybee_radiance_postprocess-0.4.380.dist-info/RECORD,,
+honeybee_radiance_postprocess-0.4.382.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_radiance_postprocess-0.4.382.dist-info/METADATA,sha256=DeEtlz8Lf-hWRWxvzy4jNJBGBApQ_QiJVg06alRBAQo,2245
+honeybee_radiance_postprocess-0.4.382.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
+honeybee_radiance_postprocess-0.4.382.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
+honeybee_radiance_postprocess-0.4.382.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
+honeybee_radiance_postprocess-0.4.382.dist-info/RECORD,,