honeybee-radiance-postprocess 0.4.495__tar.gz → 0.4.497__tar.gz

{honeybee_radiance_postprocess-0.4.495 → honeybee_radiance_postprocess-0.4.497}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.495
+Version: 0.4.497
 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.495 → honeybee_radiance_postprocess-0.4.497}/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.497/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(240, 170, 130), Color(250, 200, 170), 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.495 → honeybee_radiance_postprocess-0.4.497}/honeybee_radiance_postprocess/cli/well.py

@@ -1,8 +1,14 @@
 """honeybee-radiance-postprocess WELL commands."""
 import sys
 import logging
+import json
+import os
 import click
 
+from ladybug.color import Color
+from ladybug.datatype.generic import GenericType
+from ladybug.legend import LegendParameters
+
 from ..well.well import well_annual_daylight
 
 _logger = logging.getLogger(__name__)
@@ -45,6 +51,7 @@ def well_daylight(
     Args:
         folder: Results folder. This folder is an output folder of annual daylight
             recipe. The daylight simulation must include aperture groups.
+        daylight_hours: Daylight hours schedule for EN 17037.
     """
     with open(daylight_hours) as hourly_schedule:
         daylight_hours = [int(float(v)) for v in hourly_schedule]
@@ -58,3 +65,46 @@ def well_daylight(
         sys.exit(1)
     else:
         sys.exit(0)
+
+
+@well.command('well-daylight-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 well_daylight_vis(output_folder):
+    """Write visualization metadata files for WELL Daylight."""
+    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 = {
+        'L01': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('sDA200,40%', '').to_dict(),
+            'unit': '',
+            'legend_parameters': pass_fail_lpar.to_dict()
+        },
+        'L06': {
+            'type': 'VisualizationMetaData',
+            'data_type': GenericType('sDA300,50%', '').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.495 → honeybee_radiance_postprocess-0.4.497}/honeybee_radiance_postprocess/well/well.py

@@ -5,8 +5,8 @@ import json
 import numpy as np
 
 from ladybug.analysisperiod import AnalysisPeriod
-from ladybug.datatype.generic import GenericType
 from ladybug.datacollection import HourlyContinuousCollection
+from ladybug.datatype.generic import GenericType
 from ladybug.header import Header
 from honeybee.model import Model
 from honeybee.units import conversion_factor_to_meters
@@ -458,6 +458,27 @@ def well_annual_daylight(
         da_file.parent.mkdir(parents=True, exist_ok=True)
         np.savetxt(da_file, da, fmt='%.2f')
 
+    sda_pf_folder = ies_lm_folder.joinpath('pass_fail')
+    sda_pf_folder.mkdir(parents=True, exist_ok=True)
+    for l01_pf, grid_info in zip(l01_pass_sda_grids, grids_info):
+        grid_id = grid_info['full_id']
+        l01_sda_pf_folder = sda_pf_folder.joinpath('L01')
+        l01_sda_pf_folder.mkdir(parents=True, exist_ok=True)
+        l01_pf_file = l01_sda_pf_folder.joinpath(f'{grid_id}.pf')
+        l01_pf = l01_pf.astype(int)
+        np.savetxt(l01_pf_file, l01_pf, fmt='%d')
+        grids_info_file = l01_sda_pf_folder.joinpath('grids_info.json')
+        grids_info_file.write_text(json.dumps(grids_info, indent=2))
+    for l06_pf, grid_info in zip(l06_pass_sda_grids, grids_info):
+        grid_id = grid_info['full_id']
+        l06_sda_pf_folder = sda_pf_folder.joinpath('L06')
+        l06_sda_pf_folder.mkdir(parents=True, exist_ok=True)
+        l06_pf_file = l06_sda_pf_folder.joinpath(f'{grid_id}.pf')
+        l06_pf = l06_pf.astype(int)
+        np.savetxt(l06_pf_file, l06_pf, fmt='%d')
+        grids_info_file = l06_sda_pf_folder.joinpath('grids_info.json')
+        grids_info_file.write_text(json.dumps(grids_info, indent=2))
+
     da_grids_info_file = l06_ies_lm_folder.joinpath(
         'results', 'da', 'grids_info.json')
     da_grids_info_file.write_text(json.dumps(grids_info, indent=2))

{honeybee_radiance_postprocess-0.4.495 → honeybee_radiance_postprocess-0.4.497}/honeybee_radiance_postprocess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.495
+Version: 0.4.497
 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.495/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)