honeybee-radiance-postprocess 0.4.496__py2.py3-none-any.whl → 0.4.498__py2.py3-none-any.whl

honeybee_radiance_postprocess/breeam/breeam.py

@@ -396,6 +396,10 @@ def breeam_daylight_assessment_4b(
                 metrics_summary['comply'] = True
             else:
                 metrics_summary['comply'] = False
+            metrics_summary['average-comply'] = True if avg_comply else False
+            metrics_summary['minimum-comply'] = True if minimum_comply else False
+            
+            metrics_summary['count'] = grid_info['count']
 
             type_summary[program_type][grid_info['full_id']].append(metrics_summary)
 
@@ -467,12 +471,31 @@ def breeam_daylight_assessment_4b(
         credit_summary.append(_building_type_summary)
 
     if sub_folder:
-        folder = Path(sub_folder)
-        folder.mkdir(parents=True, exist_ok=True)
+        sub_folder = Path(sub_folder)
+        sub_folder.mkdir(parents=True, exist_ok=True)
 
-        credit_summary_file = folder.joinpath('summary.json')
+        credit_summary_file = sub_folder.joinpath('summary.json')
         credit_summary_file.write_text(json.dumps(credit_summary, indent=2))
-        program_summary_file = folder.joinpath('program_summary.json')
+        program_summary_file = sub_folder.joinpath('program_summary.json')
         program_summary_file.write_text(json.dumps(program_summary, indent=2))
 
+        pf_folder = sub_folder.joinpath('pass_fail')
+        pf_folder.mkdir(parents=True, exist_ok=True)
+        grids_info_file = pf_folder.joinpath('grids_info.json')
+        grids_info_file.write_text(json.dumps(grids_info, indent=2))
+        for program_type, grid_summary in type_summary.items():
+            for grid_id, metrics_list in grid_summary.items():
+                fill_value = 0
+                for metric in metrics_list:
+                    if metric['comply']:
+                        fill_value = 3
+                        break
+                    elif metric['average-comply']:
+                        fill_value = 2
+                    elif metric['minimum-comply']:
+                        fill_value = 1
+                pf_file = pf_folder.joinpath(f'{grid_id}.pf')
+                pf_array = np.full(metric['count'], fill_value)
+                np.savetxt(pf_file, pf_array, fmt='%d')
+
     return credit_summary, program_summary

honeybee_radiance_postprocess/cli/breeam.py

@@ -2,8 +2,14 @@
 import sys
 import logging
 from pathlib import Path
+import os
+import json
 import click
 
+from ladybug.color import Color
+from ladybug.datatype.generic import GenericType
+from ladybug.legend import LegendParameters
+
 from honeybee_radiance_postprocess.breeam.breeam import breeam_daylight_assessment_4b
 
 _logger = logging.getLogger(__name__)
@@ -45,3 +51,41 @@ def breeam_4b(
         sys.exit(1)
     else:
         sys.exit(0)
+
+
+@breeam.command('breeam-4b-vis-metadata')
+@click.option(
+    '--output-folder', '-o', help='Output folder for vis metadata files.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True),
+    default='visualization', show_default=True
+)
+def breeam_4b_vis(output_folder):
+    """Write visualization metadata files for BREEAM 4b."""
+    colors = [Color(220, 0, 0), Color(220, 110, 25), Color(255, 190, 0), Color(0, 220, 0)]
+    pass_fail_lpar = \
+        LegendParameters(min=0, max=3, colors=colors, segment_count=4, title='Pass/Fail')
+    pass_fail_lpar.ordinal_dictionary = {
+        0: 'Fail', 1: 'Min. illuminance only', 2: 'Avg. illuminance only', 3: 'Pass'}
+
+    metric_info_dict = {
+        'pass_fail': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('Pass/Fail', '').to_dict(),
+            'unit': '',
+            'legend_parameters': pass_fail_lpar.to_dict()
+        }
+    }
+    try:
+        if not os.path.exists(output_folder):
+            os.mkdir(output_folder)
+        for metric, data in metric_info_dict.items():
+            if not os.path.exists(os.path.join(output_folder, metric)):
+                os.mkdir(os.path.join(output_folder, metric))
+            file_path = os.path.join(output_folder, metric, 'vis_metadata.json')
+            with open(file_path, 'w') as fp:
+                json.dump(data, fp, indent=4)
+    except Exception:
+        _logger.exception('Failed to write the visualization metadata files.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/cli/leed.py

@@ -5,6 +5,10 @@ import logging
 import os
 import click
 
+from ladybug.color import Color
+from ladybug.datatype.generic import GenericType
+from ladybug.legend import LegendParameters
+
 from ..leed.leed import leed_option_one
 from ..results.annual_daylight import AnnualDaylight
 
@@ -94,3 +98,46 @@ def daylight_option_one(
         sys.exit(1)
     else:
         sys.exit(0)
+
+
+@leed.command('leed-daylight-option-one-vis-metadata')
+@click.option(
+    '--output-folder', '-o', help='Output folder for vis metadata files.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True),
+    default='visualization', show_default=True
+)
+def leed_daylight_optione_one_vis(output_folder):
+    """Write visualization metadata files for LEED Daylight Option I."""
+    colors = [Color(220, 0, 0), Color(0, 220, 0)]
+    pass_fail_lpar = \
+        LegendParameters(min=0, max=1, colors=colors, segment_count=2, title='Pass/Fail')
+    pass_fail_lpar.ordinal_dictionary = {0: "Fail", 1: "Pass"}
+
+    metric_info_dict = {
+        'DA': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('DA300,50%', '').to_dict(),
+            'unit': '',
+            'legend_parameters': pass_fail_lpar.to_dict()
+        },
+        'ASE': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('ASE1000,250hrs', '').to_dict(),
+            'unit': '',
+            'legend_parameters': pass_fail_lpar.to_dict()
+        }
+    }
+    try:
+        if not os.path.exists(output_folder):
+            os.mkdir(output_folder)
+        for metric, data in metric_info_dict.items():
+            if not os.path.exists(os.path.join(output_folder, metric)):
+                os.mkdir(os.path.join(output_folder, metric))
+            file_path = os.path.join(output_folder, metric, 'vis_metadata.json')
+            with open(file_path, 'w') as fp:
+                json.dump(data, fp, indent=4)
+    except Exception:
+        _logger.exception('Failed to write the visualization metadata files.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

honeybee_radiance_postprocess/cli/well.py

@@ -1,9 +1,9 @@
 """honeybee-radiance-postprocess WELL commands."""
 import sys
 import logging
-import click
 import json
 import os
+import click
 
 from ladybug.color import Color
 from ladybug.datatype.generic import GenericType

honeybee_radiance_postprocess/leed/leed.py

@@ -740,6 +740,27 @@ def leed_option_one(
             folder.joinpath('states_schedule_err.json')
         states_schedule_err_file.write_text(json.dumps(fail_to_comply))
 
+        pf_folder = folder.joinpath('pass_fail')
+        pf_folder.mkdir(parents=True, exist_ok=True)
+        for pass_sda_grid, pass_ase_grid, grid_info in zip(
+                pass_sda_grids, pass_ase_grids, grids_info):
+            grid_id = grid_info['full_id']
+            da_pf_folder = pf_folder.joinpath('DA')
+            da_pf_folder.mkdir(parents=True, exist_ok=True)
+            da_pf_file = da_pf_folder.joinpath(f'{grid_id}.pf')
+            pass_sda_grid = pass_sda_grid.astype(int)
+            np.savetxt(da_pf_file, pass_sda_grid, fmt='%d')
+            grids_info_file = da_pf_folder.joinpath('grids_info.json')
+            grids_info_file.write_text(json.dumps(grids_info, indent=2))
+
+            ase_pf_folder = pf_folder.joinpath('ASE')
+            ase_pf_folder.mkdir(parents=True, exist_ok=True)
+            ase_pf_file = ase_pf_folder.joinpath(f'{grid_id}.pf')
+            pass_ase_grid = pass_ase_grid.astype(int)
+            np.savetxt(ase_pf_file, pass_ase_grid, fmt='%d')
+            grids_info_file = ase_pf_folder.joinpath('grids_info.json')
+            grids_info_file.write_text(json.dumps(grids_info, indent=2))
+
     return (summary, summary_grid, da_grids, hours_above, states_schedule,
             fail_to_comply, grids_info)
 

honeybee_radiance_postprocess/metrics.py

@@ -295,11 +295,16 @@ def ase_array2d(
             Defaults to 1000.
 
     Returns:
-        A NumPy float of the ASE as a percentage (decimal).
+        A Tuple with two values.
+
+        -   ase: NumPy float of the ASE as a percentage (decimal).
+
+        -   h_above: 1D NumPy array of the number of hours above the direct
+            threshold.
     """
     check_array_dim(array, 2)
     h_above = (array > direct_threshold).sum(axis=1)
-    ase = (h_above > occ_hours).sum() / array.shape[0] * 100
+    ase = (h_above >= occ_hours).sum() / array.shape[0] * 100
 
     return ase, h_above
 

{honeybee_radiance_postprocess-0.4.496.dist-info → honeybee_radiance_postprocess-0.4.498.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.496
+Version: 0.4.498
 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.496.dist-info → honeybee_radiance_postprocess-0.4.498.dist-info}/RECORD

@@ -8,19 +8,19 @@ honeybee_radiance_postprocess/dynamic.py,sha256=RPJh2SsjASYJCsG5QRkazVCvzWjzMxm9
 honeybee_radiance_postprocess/electriclight.py,sha256=E7uhq7-YtZ02F9a1FbEdrXnxmYJNOFnfLF0Yw3JLQ-g,732
 honeybee_radiance_postprocess/en17037.py,sha256=h3W1ewnVsLSBamArowMkQKYaJfpKV8updJxQuTkB31k,10800
 honeybee_radiance_postprocess/helper.py,sha256=qz5kaJxzy1tGBfVYYXc2cEToOCoj0YLOtwjr3LVI3YU,9000
-honeybee_radiance_postprocess/metrics.py,sha256=6EHCuXf5jnhh6GglI9mTd0MFpfhfPFoKMf4b5gKRTMI,14038
+honeybee_radiance_postprocess/metrics.py,sha256=yrUbdUfqQHWr2lGPhG9BRtG7eHbEaOrrjH9kAkL-6RA,14180
 honeybee_radiance_postprocess/reader.py,sha256=p4A91amyCI16lRRn0bhZdInsg-qJV0Jas3v4YVhRx-4,2674
 honeybee_radiance_postprocess/type_hints.py,sha256=4R0kZgacQrqzoh8Tq7f8MVzUDzynV-C_jlh80UV6GPE,1122
 honeybee_radiance_postprocess/util.py,sha256=uxqop4TsUMp8l8iLQf784NJINprHCgj00GZHvTth1C0,5603
 honeybee_radiance_postprocess/vis_metadata.py,sha256=7ywIgdiuNKcctxifhpy7-Q2oaSX2ngQBeA0Kh7q1Gg0,1780
 honeybee_radiance_postprocess/breeam/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
-honeybee_radiance_postprocess/breeam/breeam.py,sha256=CqHfyeA8m-ZSO22DQcKu2TK9lEeyBP7hX639rDYUW4g,17118
+honeybee_radiance_postprocess/breeam/breeam.py,sha256=0krsh8gIRpTTSi86GnAIpCIYkvWy0bi6WwJjz-co53o,18279
 honeybee_radiance_postprocess/cli/__init__.py,sha256=_mYHnIOpH0qJ4QK56SB3qUT2Duuts2GR2U_0t_uE-2s,958
 honeybee_radiance_postprocess/cli/abnt.py,sha256=RmEjhxdEK6Uks3S10rQs6n8cup9qv036qRwh_wj1taA,15705
-honeybee_radiance_postprocess/cli/breeam.py,sha256=kBe36uCLcbk-y-hmZwKXquG-wVeFJbU9bEGv2x3bgm4,1442
+honeybee_radiance_postprocess/cli/breeam.py,sha256=-mkQDUgFksfPiZwMgbp4i-qh2PYzl-hGc7LFmsVpS90,3144
 honeybee_radiance_postprocess/cli/datacollection.py,sha256=Wb3UX03uW4OUZP7jWHftKfdf3aO_FSXjrnrziR3taf0,4541
 honeybee_radiance_postprocess/cli/grid.py,sha256=gqnU3-HdggWCUg9mA1RLZJYHM7tH0v6r2E_X2SSkAig,11256
-honeybee_radiance_postprocess/cli/leed.py,sha256=bxGX2UBehYNcaPJWHL2yEasSP6dATD7B0aNNQOflqqM,3712
+honeybee_radiance_postprocess/cli/leed.py,sha256=vup_tVcSnSO5R7U_WPVDAhtSSRrPzTUgV4j9lyxvxEk,5546
 honeybee_radiance_postprocess/cli/merge.py,sha256=oOqqud3VSo-3f3coDoUILcp78OI4DKxXLWCS1bi3PC4,5752
 honeybee_radiance_postprocess/cli/mtxop.py,sha256=UZJnjNpPjDmShy1-Mxos4H2vTUqk_yP3ZyaC1_LLFeI,5015
 honeybee_radiance_postprocess/cli/postprocess.py,sha256=ZN7G79gDq3Dag2vUwliFWxxZp-gk3ON2sIm9RSwCXDw,39317
@@ -29,12 +29,12 @@ honeybee_radiance_postprocess/cli/translate.py,sha256=rwUjjDK_Ttjen4ooAMvugyDN5x
 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/cli/well.py,sha256=b9ebwF4zyHGk9MUhbghj34BEJHryJMaPebZ3sd89FWQ,3772
+honeybee_radiance_postprocess/cli/well.py,sha256=wWz-aWon4E_tLar0mepolW8WJdk6hF869wZPZSkbNrE,3772
 honeybee_radiance_postprocess/ies/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
 honeybee_radiance_postprocess/ies/lm.py,sha256=6f1LDiAWGEX7IvU8OavGC6POlXpgpYp_QFBCHhowo0s,9370
 honeybee_radiance_postprocess/ies/lm_schedule.py,sha256=ci58GXq2PntJ4yNUdI_x4UCRmq6KrLes-u7GeboX058,9954
 honeybee_radiance_postprocess/leed/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
-honeybee_radiance_postprocess/leed/leed.py,sha256=Md7ASfnNq6enxJpaBzLmglTv7Zg9q7pPo8r9RHKRoCU,34240
+honeybee_radiance_postprocess/leed/leed.py,sha256=-oHi5dxPeJQaWBL7BKyK_ZxxMehQuoVcgQyWMQdq8EA,35383
 honeybee_radiance_postprocess/leed/leed_schedule.py,sha256=s3by1sv1DtOlCawvaMvnIDvEo5D8ATEJvWQ_rEeJIHg,9956
 honeybee_radiance_postprocess/results/__init__.py,sha256=1agBQbfT4Tf8KqSZzlfKYX8MeZryY4jJ1KB4HWqaDDk,182
 honeybee_radiance_postprocess/results/annual_daylight.py,sha256=11d4J1iIuITKuoWyWa-2_2WdrHYBULC0YP-mWBWi4JQ,34724
@@ -42,9 +42,9 @@ honeybee_radiance_postprocess/results/annual_irradiance.py,sha256=5zwrr4MNeHUebb
 honeybee_radiance_postprocess/results/results.py,sha256=8wpxu6HBnrJXRoTkI7ucNuzhVmNKw1Z2zPP6wzk7ULQ,55236
 honeybee_radiance_postprocess/well/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
 honeybee_radiance_postprocess/well/well.py,sha256=Fs81hs5e2UaVo2hlbHiRsxiSQHfSMvCt6ZT1a4psF9E,22350
-honeybee_radiance_postprocess-0.4.496.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_radiance_postprocess-0.4.496.dist-info/METADATA,sha256=3lzksacDnCpTpEwdxDU9s5CxAo1Zmxupu8PtOLUtl-A,2238
-honeybee_radiance_postprocess-0.4.496.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-honeybee_radiance_postprocess-0.4.496.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
-honeybee_radiance_postprocess-0.4.496.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
-honeybee_radiance_postprocess-0.4.496.dist-info/RECORD,,
+honeybee_radiance_postprocess-0.4.498.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_radiance_postprocess-0.4.498.dist-info/METADATA,sha256=Q_ZOGRSPF9lW9nW6RDHk9HyFY5WKvHQ06c-oqRh3doM,2238
+honeybee_radiance_postprocess-0.4.498.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+honeybee_radiance_postprocess-0.4.498.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
+honeybee_radiance_postprocess-0.4.498.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
+honeybee_radiance_postprocess-0.4.498.dist-info/RECORD,,