honeybee-radiance-postprocess 0.4.496__tar.gz → 0.4.498__tar.gz

{honeybee_radiance_postprocess-0.4.496 → honeybee_radiance_postprocess-0.4.498}/PKG-INFO

@@ -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 → honeybee_radiance_postprocess-0.4.498}/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-0.4.498/honeybee_radiance_postprocess/cli/breeam.py

@@ -0,0 +1,91 @@
+"""Commands for BREEAM post-processing."""
+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__)
+
+
+@click.group(help='Commands for BREEAM post-processing of Radiance results.')
+def breeam():
+    pass
+
+
+@breeam.command('breeam-4b')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option('--model-file', '-m', help='A Honeybee Model file that was used '
+    'in the simulation.', type=click.Path(
+    exists=False, file_okay=True, dir_okay=False, resolve_path=True))
+@click.option(
+    '--sub-folder', '-sf', help='Relative path for subfolder to write output '
+    'files.', default='breeam_summary', type=click.Path(
+    exists=False, file_okay=False, dir_okay=True, resolve_path=True, path_type=Path)
+)
+def breeam_4b(
+    folder, model_file, sub_folder
+):
+    """Calculate metrics for BREEAM.
+
+    \b
+    Args:
+        folder: Results folder. This folder is an output folder of annual daylight
+            recipe.
+        model-file: A Honeybee Model file that was used in the simulation.
+    """
+    try:
+        breeam_daylight_assessment_4b(folder, model=model_file, sub_folder=sub_folder)
+    except Exception:
+        _logger.exception('Failed to calculate BREEAM metrics.')
+        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-0.4.496 → honeybee_radiance_postprocess-0.4.498}/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-0.4.496 → honeybee_radiance_postprocess-0.4.498}/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-0.4.496 → honeybee_radiance_postprocess-0.4.498}/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 → honeybee_radiance_postprocess-0.4.498}/honeybee_radiance_postprocess.egg-info/PKG-INFO

@@ -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/honeybee_radiance_postprocess/cli/breeam.py

@@ -1,47 +0,0 @@
-"""Commands for BREEAM post-processing."""
-import sys
-import logging
-from pathlib import Path
-import click
-
-from honeybee_radiance_postprocess.breeam.breeam import breeam_daylight_assessment_4b
-
-_logger = logging.getLogger(__name__)
-
-
-@click.group(help='Commands for BREEAM post-processing of Radiance results.')
-def breeam():
-    pass
-
-
-@breeam.command('breeam-4b')
-@click.argument(
-    'folder',
-    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
-)
-@click.option('--model-file', '-m', help='A Honeybee Model file that was used '
-    'in the simulation.', type=click.Path(
-    exists=False, file_okay=True, dir_okay=False, resolve_path=True))
-@click.option(
-    '--sub-folder', '-sf', help='Relative path for subfolder to write output '
-    'files.', default='breeam_summary', type=click.Path(
-    exists=False, file_okay=False, dir_okay=True, resolve_path=True, path_type=Path)
-)
-def breeam_4b(
-    folder, model_file, sub_folder
-):
-    """Calculate metrics for BREEAM.
-
-    \b
-    Args:
-        folder: Results folder. This folder is an output folder of annual daylight
-            recipe.
-        model-file: A Honeybee Model file that was used in the simulation.
-    """
-    try:
-        breeam_daylight_assessment_4b(folder, model=model_file, sub_folder=sub_folder)
-    except Exception:
-        _logger.exception('Failed to calculate BREEAM metrics.')
-        sys.exit(1)
-    else:
-        sys.exit(0)

{honeybee_radiance_postprocess-0.4.496 → honeybee_radiance_postprocess-0.4.498}/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