honeybee-radiance-postprocess 0.4.555__py3-none-any.whl

honeybee_radiance_postprocess/breeam/breeam.py

@@ -0,0 +1,552 @@
+"""Functions for BREEAM post-processing."""
+from typing import Union
+from pathlib import Path
+import json
+try:
+    import cupy as np
+    is_gpu = True
+except ImportError:
+    is_gpu = False
+    import numpy as np
+
+from honeybee.model import Model
+from honeybee_radiance.writer import _filter_by_pattern
+
+from ..results.annual_daylight import AnnualDaylight
+
+
+program_type_metrics = {
+    'BREEAM::Education_buildings::Preschools': [
+        {
+            'type': 'Education buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Education_buildings::Higher_education': [
+        {
+            'type': 'Education buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        },
+        {
+            'type': 'Education buildings',
+            'credits': 1,
+            'area': 60,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Healthcare_buildings::Staff_and_public_areas': [
+        {
+            'type': 'Healthcare buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2650
+            }
+        },
+        {
+            'type': 'Healthcare buildings',
+            'credits': 1,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Healthcare_buildings::Patients_areas_and_consulting_rooms': [
+        {
+            'type': 'Healthcare buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2650
+            }
+        },
+        {
+            'type': 'Healthcare buildings',
+            'credits': 1,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Multi_residential_buildings::Kitchen': [
+        {
+            'type': 'Multi-residential buildings',
+            'credits': 2,
+            'area': 100,
+            'average_daylight_illuminance': {
+                'illuminance': 100,
+                'hours': 3450
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 30,
+                'hours': 3450
+            }
+        }
+    ],
+    'BREEAM::Multi_residential_buildings::Living_rooms_dining_rooms_studies': [
+        {
+            'type': 'Multi-residential buildings',
+            'credits': 2,
+            'area': 100,
+            'average_daylight_illuminance': {
+                'illuminance': 100,
+                'hours': 3450
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 30,
+                'hours': 3450
+            }
+        }
+    ],
+    'BREEAM::Multi_residential_buildings::Non_residential_or_communal_spaces': [
+        {
+            'type': 'Multi-residential buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 200,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 60,
+                'hours': 2650
+            }
+        }
+    ],
+    'BREEAM::Retail_buildings::Sales_areas': [
+        {
+            'type': 'Retail buildings',
+            'credits': 1,
+            'area': 35,
+            'average_daylight_illuminance': {
+                'illuminance': 200,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 200,
+                'hours': 2650
+            }
+        }
+    ],
+    'BREEAM::Retail_buildings::Other_occupied_areas': [
+        {
+            'type': 'Retail buildings',
+            'credits': 1,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 200,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 60,
+                'hours': 2650
+            }
+        }
+    ],
+    'BREEAM::Prison_buildings::Cells_and_custody_cells': [
+        {
+            'type': 'Prison buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 100,
+                'hours': 3150
+            },
+            'minimum_daylight_illuminance': None
+        }
+    ],
+    'BREEAM::Prison_buildings::Internal_association_or_atrium': [
+        {
+            'type': 'Prison buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 210,
+                'hours': 2650
+            }
+        }
+    ],
+    'BREEAM::Prison_buildings::Patient_care_spaces': [
+        {
+            'type': 'Prison buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2650
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 210,
+                'hours': 2650
+            }
+        }
+    ],
+    'BREEAM::Prison_buildings::Teaching_lecture_and_seminar_spaces': [
+        {
+            'type': 'Prison buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Office_buildings::Occupied_spaces': [
+        {
+            'type': 'Office buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Crèche_buildings::Occupied_spaces': [
+        {
+            'type': 'Crèche buildings',
+            'credits': 2,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ],
+    'BREEAM::Other_buildings::Occupied_spaces': [
+        {
+            'type': 'Other buildings',
+            'credits': 1,
+            'area': 80,
+            'average_daylight_illuminance': {
+                'illuminance': 300,
+                'hours': 2000
+            },
+            'minimum_daylight_illuminance': {
+                'illuminance': 90,
+                'hours': 2000
+            }
+        }
+    ]
+}
+
+
+def breeam_daylight_assessment_4b(
+        results: Union[str, AnnualDaylight], model: Union[str, Path, Model] = None,
+        grids_filter: str = '*', sub_folder: str = None):
+    """Calculate credits for BREEAM 4b.
+
+    Args:
+        results: Path to results folder or a Results class object.
+        model: A model as a path or a HB Model object. If None, the function
+            will look for a model in the parent of the results folder. If a model
+            does not exist in this directory the function will raise an error.
+            Defaults to None.
+        grids_filter: The name of a grid or a pattern to filter the grids.
+            Defaults to '*'.
+        sub_folder: Relative path for a subfolder to write the output. If None,
+            the files will not be written. Defaults to None.
+
+    Returns:
+        Tuple:
+        -   credit_summary: Summary of each building type.
+        -   program_summary: Summary of program type / space type.
+    """
+    if not isinstance(results, AnnualDaylight):
+        results = AnnualDaylight(results)
+
+    grids_info = results._filter_grids(grids_filter=grids_filter)
+
+    # check to see if there is a HBJSON with sensor grid meshes for areas
+    grid_areas = {}
+    grid_program_types = {}
+    if model is None:
+        found_file = False
+        for base_file in Path(results.folder).parent.iterdir():
+            if base_file.suffix in ('.hbjson', '.hbpkl'):
+                hb_model: Model = Model.from_file(base_file)
+                found_file = True
+                break
+        if not found_file:
+            raise FileNotFoundError(
+                'Found no hbjson or hbpkl file in parent of results folder.')
+    else:
+        if isinstance(model, Model):
+            hb_model = model
+        else:
+            hb_model = Model.from_file(model)
+
+    filt_grids = _filter_by_pattern(
+        hb_model.properties.radiance.sensor_grids, filter=grids_filter)
+    for s_grid in filt_grids:
+        if s_grid.mesh is not None:
+            grid_areas[s_grid.identifier] = int(np.array(s_grid.mesh.face_areas).sum())
+        else:
+            grid_areas[s_grid.identifier] = None
+        hb_room = hb_model.rooms_by_identifier([s_grid.room_identifier])[0]
+        try:
+            program_type_id = hb_room.properties.energy.program_type.identifier
+        except AttributeError as e:
+            raise ImportError('honeybee_energy library must be installed to use '
+                              'breeam_daylight_assessment method. {}'.format(e))
+        if program_type_id in program_type_metrics:
+            grid_program_types[s_grid.identifier] = program_type_id
+
+    if not grid_areas:
+        grid_areas = {grid_info['full_id']: None for grid_info in grids_info}
+
+    sensor_grid_mapper = {}
+    for sg in hb_model.properties.radiance.sensor_grids:
+        sensor_grid_mapper[sg.identifier] = sg
+
+    grid_summary = {}
+    type_summary = {}
+    minimum_illuminance_sensors = {}
+    for grid_info in grids_info:
+        program_type = grid_program_types.get(grid_info['full_id'], None)
+        if program_type is None:
+            continue
+        if program_type not in type_summary:
+            type_summary[program_type] = {}  # add dict for program type
+        type_summary[program_type][grid_info['full_id']] = []
+
+        array = results._array_from_states(grid_info, zero_array=True)
+        # calculate average along axis 0 (average for each hour)
+        avg_ill = array.mean(axis=0)
+
+        metrics_list = program_type_metrics[program_type]
+        for metrics in metrics_list:
+            metrics_summary = {}
+            metrics_summary['type'] = metrics['type']
+            metrics_summary['area'] = grid_areas[grid_info['full_id']]
+            # calculate number of hours where avg. illuminance > target illuminance
+            target_ill = metrics['average_daylight_illuminance']['illuminance']
+            hrs_abv_avg = (avg_ill >= target_ill).sum()
+            # check if value is >= target hours
+            target_hrs = metrics['average_daylight_illuminance']['hours']
+            avg_comply = hrs_abv_avg >= target_hrs
+
+            # calculate number of hours where illuminance > target illuminance
+            if program_type == 'BREEAM::Prison_buildings::Cells_and_custody_cells':
+                min_comply = True  # no minimum daylight illuminance for this space
+            else:
+                target_ill = metrics['minimum_daylight_illuminance']['illuminance']
+                hrs_abv_target = (array >= target_ill).sum(axis=1)
+                # get the minimum, i.e., worst lit point
+                hrs_abv_min = np.min(hrs_abv_target)
+                # check if values is >= target hours
+                target_hrs = metrics['minimum_daylight_illuminance']['hours']
+                min_comply = hrs_abv_min >= target_hrs
+
+                minimum_illuminance_index = int(np.argsort(hrs_abv_target)[0])
+                minimum_illuminance_sensor = \
+                    sensor_grid_mapper[grid_info['full_id']].sensors[minimum_illuminance_index]
+                minimum_illuminance_sensors[grid_info['full_id']] = \
+                    minimum_illuminance_sensor.to_dict()
+
+            metrics_summary['credits'] = metrics['credits']
+            if avg_comply and min_comply:
+                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 min_comply else False
+
+            metrics_summary['count'] = grid_info['count']
+
+            metrics_summary['average-illuminance-hours'] = hrs_abv_avg
+            metrics_summary['minimum-illuminance-hours'] = hrs_abv_min
+
+            type_summary[program_type][grid_info['full_id']].append(metrics_summary)
+
+        grid_summary[grid_info['full_id']] = {
+            'type': metrics['type'],
+            'program-type': program_type,
+            'display-name': grid_info['name'],
+            'average-illuminance-hours': hrs_abv_avg.item(),
+            'minimum-illuminance-hours': hrs_abv_min.item()
+        }
+
+    program_summary = []
+    for program_type, _grid_summary in type_summary.items():
+        program_type_summary = {}
+        program_type_summary['program_type'] = program_type
+        program_type_summary['credits'] = 0  # set 0 by default
+        program_type_summary['comply'] = False  # set False by default
+
+        metrics_summary = {}
+        for grid_id, metrics_list in _grid_summary.items():
+            for metric in metrics_list:
+                if metric['credits'] not in metrics_summary:
+                    metrics_summary[metric['credits']] = {}
+                metrics_summary[metric['credits']]['type'] = metric['type']
+                if 'total_area' not in metrics_summary[metric['credits']]:
+                    metrics_summary[metric['credits']]['total_area'] = 0
+                metrics_summary[metric['credits']]['total_area'] += metric['area']
+                if 'area_comply' not in metrics_summary[metric['credits']]:
+                    metrics_summary[metric['credits']]['area_comply'] = 0
+                if metric['comply']:
+                    metrics_summary[metric['credits']]['area_comply'] += metric['area']
+
+        for credit, metric_summary in metrics_summary.items():
+            area_comply_pct = metric_summary['area_comply'] / metric_summary['total_area'] * 100
+            metric_summary['area_comply_%'] = area_comply_pct
+            for metric in program_type_metrics[program_type]:
+                if credit == metric['credits']:
+                    if area_comply_pct >= metric['area']:
+                        metric_summary['comply'] = True
+                    else:
+                        metric_summary['comply'] = False
+
+        for credit, metric_summary in metrics_summary.items():
+            if metric_summary['comply'] and credit > program_type_summary['credits']:
+                program_type_summary['comply'] = True
+                program_type_summary['credits'] = credit
+                program_type_summary['total_area'] = metric_summary['total_area']
+                program_type_summary['area_comply'] = metric_summary['area_comply']
+                program_type_summary['area_comply_%'] = metric_summary['area_comply_%']
+                program_type_summary['type'] = metric_summary['type']
+            else:
+                program_type_summary['total_area'] = metric_summary['total_area']
+                program_type_summary['area_comply'] = metric_summary['area_comply']
+                program_type_summary['area_comply_%'] = metric_summary['area_comply_%']
+                program_type_summary['type'] = metric_summary['type']
+
+        avg_hrs, min_hrs, areas = [], [], []
+        for grid_id, metrics_list in _grid_summary.items():
+            for metric in metrics_list:
+                areas.append(metric['area'])
+                avg_hrs.append(metric['average-illuminance-hours'])
+                min_hrs.append(metric['minimum-illuminance-hours'])
+                break  # only need to get the first one
+
+        area_proportions = np.array(areas) / program_type_summary['total_area']
+
+        weighted_hours_avg = area_proportions * np.array(avg_hrs)
+        total_weighted_hours_avg = int(np.sum(weighted_hours_avg))
+        program_type_summary['average-illuminance-hours'] = total_weighted_hours_avg
+
+        weighted_hours_min = area_proportions * np.array(min_hrs)
+        total_weighted_hours_min = int(np.sum(weighted_hours_min))
+        program_type_summary['minimum-illuminance-hours'] = total_weighted_hours_min
+
+        program_summary.append(program_type_summary)
+
+    building_type_summary = {}
+    for _program_summary in program_summary:
+        if _program_summary['type'] not in building_type_summary:
+            building_type_summary[_program_summary['type']] = []
+        building_type_summary[_program_summary['type']].append(_program_summary)
+
+    credit_summary = []
+    for building_type, summary in building_type_summary.items():
+        _building_type_summary = {}
+        _building_type_summary['type'] = building_type
+        if all([v['comply'] for v in summary]):
+            _building_type_summary['comply'] = True
+            _building_type_summary['credits'] = min([v['credits'] for v in summary])
+        else:
+            _building_type_summary['comply'] = False
+            _building_type_summary['credits'] = 0
+        _building_type_summary['total_area'] = sum([v['total_area'] for v in summary])
+
+        credit_summary.append(_building_type_summary)
+
+    if sub_folder:
+        sub_folder = Path(sub_folder)
+        sub_folder.mkdir(parents=True, exist_ok=True)
+
+        minimum_illuminance_points_file = sub_folder.joinpath('minimum_illuminance_sensors.json')
+        minimum_illuminance_points_file.write_text(
+            json.dumps(minimum_illuminance_sensors, indent=2))
+        credit_summary_file = sub_folder.joinpath('summary.json')
+        credit_summary_file.write_text(json.dumps(credit_summary, indent=2))
+        program_summary_file = sub_folder.joinpath('program_summary.json')
+        program_summary_file.write_text(json.dumps(program_summary, indent=2))
+        grid_summary_file = sub_folder.joinpath('grid_summary.json')
+        grid_summary_file.write_text(json.dumps(grid_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/__init__.py

@@ -0,0 +1,33 @@
+"""Modules for post-processing simulation outputs."""
+import click
+
+from honeybee.cli import main
+from .grid import grid
+from .mtxop import mtxop
+from .postprocess import post_process
+from .schedule import schedule
+from .translate import translate
+from .viewfactor import view_factor
+from .merge import merge
+from .datacollection import datacollection
+
+
+# command group for all postprocess extension commands.
+@click.group(help='honeybee radiance postprocess commands.')
+@click.version_option()
+def postprocess():
+    pass
+
+
+# add sub-commands to postprocess
+postprocess.add_command(grid)
+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)
+postprocess.add_command(merge)
+postprocess.add_command(datacollection, name='data-collection')
+
+# add postprocess sub-commands to honeybee CLI
+main.add_command(postprocess)