honeybee-radiance-postprocess 0.4.458__py2.py3-none-any.whl → 0.4.459__py2.py3-none-any.whl

honeybee_radiance_postprocess/cli/postprocess.py

@@ -22,6 +22,7 @@ from ..util import filter_array
 from .two_phase import two_phase
 from .leed import leed
 from .abnt import abnt
+from .well import well
 from ..helper import model_grid_areas, grid_summary
 
 _logger = logging.getLogger(__name__)
@@ -34,6 +35,7 @@ def post_process():
 post_process.add_command(two_phase)
 post_process.add_command(leed)
 post_process.add_command(abnt)
+post_process.add_command(well)
 
 @post_process.command('annual-daylight')
 @click.argument(

honeybee_radiance_postprocess/cli/well.py

@@ -0,0 +1,96 @@
+"""honeybee-radiance-postprocess WELL commands."""
+import json
+import sys
+import logging
+import os
+import click
+
+from ..well.well import well_annual_daylight
+from ..results.annual_daylight import AnnualDaylight
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands for WELL post-processing of Radiance results.')
+def well():
+    pass
+
+
+@well.command('well-annual-daylight')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--grids-filter', '-gf', help='A pattern to filter the grids.', default='*',
+    show_default=True
+)
+@click.option(
+    '--shade-transmittance', '-st', help='A value to use as a multiplier in place of '
+    'solar shading. Value for shade transmittance must be 1 > value > 0.',
+    default=0.02, show_default=True, type=click.FLOAT
+)
+@click.option(
+    '--shade-transmittance-file', '-stf', help='A JSON file with a dictionary '
+    'where aperture groups are keys, and the value for each key is the shade '
+    'transmittance. Values for shade transmittance must be 1 > value > 0. '
+    'If any aperture groups are missing in the JSON file, its shade transmittance '
+    'value will be set to the value of the --shade-transmittance option (0.02 by '
+    'default).', default=None, show_default=True,
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--use-shade-transmittance/--use-states', help='A flag to select if the '
+    'post-processing should use a shade transmittance or the simulated states '
+    'of aperture groups. Using states should only be selected if the annual '
+    'daylight simulation included ray tracing of a second (blind) state for '
+    'each aperture group.',
+    is_flag=True, default=True, show_default=True
+)
+@click.option(
+    '--sub-folder', '-sf', help='Relative path for subfolder to write output '
+    'files.', default='well_summary', show_default=True
+)
+def well_daylight(
+    folder, shade_transmittance, shade_transmittance_file, grids_filter,
+    use_shade_transmittance, sub_folder
+):
+    """Calculate credits for WELL L06.
+
+    Use the shade-transmittance option to set a shade transmittance values for
+    aperture groups. The shade-transmittance-file option takes precedence over
+    the shade-transmittance, however, if any aperture groups are missing in the
+    JSON file given to the shade-transmittance-file option, the value from
+    shade-transmittance will be used for those aperture groups.
+
+    \b
+    Args:
+        folder: Results folder. This folder is an output folder of annual daylight
+            recipe. The daylight simulation must include aperture groups.
+    """
+    use_states = not use_shade_transmittance
+    if (
+        shade_transmittance_file
+        and os.path.isfile(shade_transmittance_file)
+        and use_shade_transmittance
+    ):
+        with open(shade_transmittance_file) as json_file:
+            shd_trans = json.load(json_file)
+        results = AnnualDaylight(folder)
+        # check if aperture groups are missing in json file
+        for light_path in results.light_paths:
+            if (not light_path in shd_trans and
+                light_path != '__static_apertures__'):
+                shd_trans[light_path] = shade_transmittance
+        shade_transmittance = shd_trans
+    try:
+        well_annual_daylight(
+            folder, grids_filter=grids_filter,
+            shade_transmittance=shade_transmittance, use_states=use_states,
+            sub_folder=sub_folder
+        )
+    except Exception:
+        _logger.exception('Failed to generate LEED summary.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

{honeybee_radiance_postprocess-0.4.458.dist-info → honeybee_radiance_postprocess-0.4.459.dist-info}/METADATA

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

@@ -20,12 +20,13 @@ honeybee_radiance_postprocess/cli/grid.py,sha256=gqnU3-HdggWCUg9mA1RLZJYHM7tH0v6
 honeybee_radiance_postprocess/cli/leed.py,sha256=bxGX2UBehYNcaPJWHL2yEasSP6dATD7B0aNNQOflqqM,3712
 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=pzZ419eBt_LNNilW1y47c4lGTFxmV7cJyWnjV78GzY8,39202
+honeybee_radiance_postprocess/cli/postprocess.py,sha256=yUR0J3EQyLRiINcjFfxb-9mUeEm3U-lZefjwq--lvtU,39256
 honeybee_radiance_postprocess/cli/schedule.py,sha256=6uIy98Co4zm-ZRcELo4Lfx_aN3lNiqPe-BSimXwt1F8,3877
 honeybee_radiance_postprocess/cli/translate.py,sha256=rwUjjDK_Ttjen4ooAMvugyDN5xfltEEFURDZ_Tb1w-g,7308
 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=JaedicMSvP7wfrX8opytnShsSVN5AnIr4dN-ZJBxrxM,3686
 honeybee_radiance_postprocess/ies/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
 honeybee_radiance_postprocess/ies/lm.py,sha256=kHvwd2uT8Y-c2TjpvQzjLrWzwgayWjpzpbwS2S6cEvo,9570
 honeybee_radiance_postprocess/ies/lm_schedule.py,sha256=ci58GXq2PntJ4yNUdI_x4UCRmq6KrLes-u7GeboX058,9954
@@ -38,9 +39,9 @@ honeybee_radiance_postprocess/results/annual_irradiance.py,sha256=5zwrr4MNeHUebb
 honeybee_radiance_postprocess/results/results.py,sha256=ABb_S8kDPruhGkDsfREXMg6K0p8FRhAZ3QIRUZCQPAI,54888
 honeybee_radiance_postprocess/well/__init__.py,sha256=kQXElEqFnLGNnrMSpA51XDHoqBup849FHeAqWASIy6w,45
 honeybee_radiance_postprocess/well/well.py,sha256=hsicVYFl-2DR4mtVANzUPu9NKA760elfYoIpOKc9bkQ,17501
-honeybee_radiance_postprocess-0.4.458.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_radiance_postprocess-0.4.458.dist-info/METADATA,sha256=d7qrhbuw112O9hPaK3jCfdpjYx2Ij-rmP_95aCppTgM,2240
-honeybee_radiance_postprocess-0.4.458.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-honeybee_radiance_postprocess-0.4.458.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
-honeybee_radiance_postprocess-0.4.458.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
-honeybee_radiance_postprocess-0.4.458.dist-info/RECORD,,
+honeybee_radiance_postprocess-0.4.459.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_radiance_postprocess-0.4.459.dist-info/METADATA,sha256=iWJMWWvA_uyFhoWy2wipcmxl_SUWLMLn0Uixanlu5go,2240
+honeybee_radiance_postprocess-0.4.459.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
+honeybee_radiance_postprocess-0.4.459.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
+honeybee_radiance_postprocess-0.4.459.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
+honeybee_radiance_postprocess-0.4.459.dist-info/RECORD,,