honeybee-radiance-postprocess 0.4.335__py2.py3-none-any.whl → 0.4.337__py2.py3-none-any.whl

honeybee_radiance_postprocess/cli/postprocess.py

@@ -949,3 +949,127 @@ def annual_irradiance_metrics(
         sys.exit(1)
     else:
         sys.exit(0)
+
+
+@post_process.command('convert-to-binary')
+@click.argument(
+    'input-matrix', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.option(
+    '--minimum', type=float, default='-inf', help='Minimum range for values to be '
+    'converted to 1.'
+)
+@click.option(
+    '--maximum', type=float, default='+inf', help='Maximum range for values to be '
+    'converted to 1.'
+)
+@click.option(
+    '--include-max/--exclude-max', is_flag=True, help='A flag to include the maximum '
+    'threshold itself. By default the threshold value will be included.', default=True
+)
+@click.option(
+    '--include-min/--exclude-min', is_flag=True, help='A flag to include the minimum '
+    'threshold itself. By default the threshold value will be included.', default=True
+)
+@click.option(
+    '--comply/--reverse', is_flag=True, help='A flag to reverse the selection logic. '
+    'This is useful for cases that you want to all the values outside a certain range '
+    'to be converted to 1. By default the input logic will be used as is.', default=True
+)
+@click.option(
+    '--name', '-n', help='Name of output file.', default='binary',
+    show_default=True
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def convert_matrix_to_binary(
+    input_matrix, minimum, maximum, include_max, include_min, comply, name, output_folder
+):
+    """Postprocess a Radiance matrix and convert it to 0-1 values.
+
+    \b
+    This command is useful for translating Radiance results to outputs like
+    sunlight hours. Input matrix must be in ASCII or binary format. The input
+    Radiance file must have a header.
+
+    Args:
+        input-matrix: A Radiance matrix file.
+    """
+    array = binary_to_array(input_matrix)
+    minimum = float(minimum)
+    maximum = float(maximum)
+    try:
+        if include_max and include_min:
+            boolean_array = (array >= minimum) & (array <= maximum)
+        elif not include_max and not include_min:
+            boolean_array = (array > minimum) & (array < maximum)
+        elif include_max and not include_min:
+            boolean_array = (array > minimum) & (array <= maximum)
+        elif not include_max and include_min:
+            boolean_array = (array >= minimum) & (array < maximum)
+
+        if not comply:
+            # this will invert the boolean array
+            boolean_array = ~boolean_array
+        
+        binary_array = boolean_array.astype(int)
+        output_file = Path(output_folder, name)
+        output_file.parent.mkdir(parents=True, exist_ok=True)
+        np.save(output_file, binary_array)
+    except Exception:
+        _logger.exception('Failed to convert the input file to binary format.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+@post_process.command('direct-sun-hours')
+@click.argument(
+    'input-matrix', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+)
+@click.option(
+    '--divisor', type=float, default=1, help='An optional number, that the summed '
+    'row will be divided by. For example, this can be a timestep, which can be used '
+    'to ensure that a summed row of irradiance yields cumulative radiation over '
+    'the entire time period of the matrix.'
+)
+@click.option(
+    '--output-folder', '-of', help='Output folder.', default='.',
+    type=click.Path(exists=False, file_okay=False, dir_okay=True, resolve_path=True)
+)
+def direct_sun_hours(
+    input_matrix, divisor, output_folder
+):
+    """Postprocess a Radiance matrix to direct sun hours and cumulative direct
+    sun hours.
+
+    \b
+    This command will convert values in the Radiance matrix file to 0-1 values.
+    The output will be a direct sun hours file, and a cumulative direct sun hours
+    file where the values are the summed values for each row.
+
+    Args:
+        input-matrix: A Radiance matrix file.
+    """
+    array = binary_to_array(input_matrix)
+
+    try:
+        boolean_array = (array > 0) & (array <= np.inf)
+
+        direct_sun_hours_array = boolean_array.astype(int)
+        cumulative_array = direct_sun_hours_array.sum(axis=1) / divisor
+
+        direct_sun_hours_file = Path(output_folder, 'direct_sun_hours')
+        direct_sun_hours_file.parent.mkdir(parents=True, exist_ok=True)
+        np.save(direct_sun_hours_file, direct_sun_hours_array)
+
+        cumulative_file = Path(output_folder, 'cumulative')
+        cumulative_file.parent.mkdir(parents=True, exist_ok=True)
+        np.save(cumulative_file, cumulative_array)
+    except Exception:
+        _logger.exception('Failed to convert the input file to direct sun hours.')
+        sys.exit(1)
+    else:
+        sys.exit(0)

{honeybee_radiance_postprocess-0.4.335.dist-info → honeybee_radiance_postprocess-0.4.337.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.335
+Version: 0.4.337
 Summary: Postprocessing of Radiance results and matrices
 Home-page: https://github.com/ladybug-tools/honeybee-radiance-postprocess
 Author: Ladybug Tools
@@ -13,7 +13,7 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: honeybee-radiance (==1.66.27)
+Requires-Dist: honeybee-radiance (==1.66.28)
 Requires-Dist: numpy (>=1.21.6)
 
 [![Build Status](https://github.com/ladybug-tools/honeybee-radiance-postprocess/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-radiance-postprocess/actions)

{honeybee_radiance_postprocess-0.4.335.dist-info → honeybee_radiance_postprocess-0.4.337.dist-info}/RECORD

@@ -16,7 +16,7 @@ honeybee_radiance_postprocess/cli/__init__.py,sha256=4RkpR91GPXWatDE4I_27ce-N4Fw
 honeybee_radiance_postprocess/cli/grid.py,sha256=35MwXzL7xRfV5LgDicEEYSyDAZ7Qjlvd-cA3YDA7JAw,8984
 honeybee_radiance_postprocess/cli/leed.py,sha256=QBR6AMJJWuZ0TevyMi2tXCWMLdS-ZSqtVTZDgqxwa7M,3112
 honeybee_radiance_postprocess/cli/mtxop.py,sha256=UZJnjNpPjDmShy1-Mxos4H2vTUqk_yP3ZyaC1_LLFeI,5015
-honeybee_radiance_postprocess/cli/postprocess.py,sha256=Ypz0RBLNY4N5GpOhzrMjGiAymr-uOA-P3G3F8PGxwUU,34215
+honeybee_radiance_postprocess/cli/postprocess.py,sha256=6lSQuaLEDXRkVXeTdzEgJy5mMQeWrc8K06n9SRUc948,38905
 honeybee_radiance_postprocess/cli/schedule.py,sha256=6uIy98Co4zm-ZRcELo4Lfx_aN3lNiqPe-BSimXwt1F8,3877
 honeybee_radiance_postprocess/cli/translate.py,sha256=18zkcGeRZALJ5Z82NEB3XZ-iEX2cHyneobGWV-IXWE0,6789
 honeybee_radiance_postprocess/cli/two_phase.py,sha256=1nZF4jyZ_C7CAfiHCz1UUOEwDaB4yOXr9ga0HIrhOB0,7033
@@ -25,9 +25,9 @@ honeybee_radiance_postprocess/results/__init__.py,sha256=1agBQbfT4Tf8KqSZzlfKYX8
 honeybee_radiance_postprocess/results/annual_daylight.py,sha256=o4Y5kbD3a4X4KRfsbOlWzgrnNKU365GcivM6qQGUGXU,31605
 honeybee_radiance_postprocess/results/annual_irradiance.py,sha256=5zwrr4MNeHUebbSRpSBbscPOZUs2AHmYCQfIIbdYImY,8298
 honeybee_radiance_postprocess/results/results.py,sha256=t9tr-WHt-XpALIwClLb-xOZcWUZthnvfGED5g3NGDu8,53589
-honeybee_radiance_postprocess-0.4.335.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-honeybee_radiance_postprocess-0.4.335.dist-info/METADATA,sha256=H5u9UfHUb-Wd1tAHNU0N4-fUFhONnwNKFMX6jfL-lz4,2228
-honeybee_radiance_postprocess-0.4.335.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
-honeybee_radiance_postprocess-0.4.335.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
-honeybee_radiance_postprocess-0.4.335.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
-honeybee_radiance_postprocess-0.4.335.dist-info/RECORD,,
+honeybee_radiance_postprocess-0.4.337.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+honeybee_radiance_postprocess-0.4.337.dist-info/METADATA,sha256=mRGcxz_CozPU9zfnbk7tw-sTae1y35JtpUzkhwNjZko,2228
+honeybee_radiance_postprocess-0.4.337.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
+honeybee_radiance_postprocess-0.4.337.dist-info/entry_points.txt,sha256=gFtVPx6UItXt27GfEZZO00eOZChJJEL6JwGSAB_O3rs,96
+honeybee_radiance_postprocess-0.4.337.dist-info/top_level.txt,sha256=4-sFbzy7ewP2EDqJV3jeFlAFx7SuxtoBBELWaKAnLdA,30
+honeybee_radiance_postprocess-0.4.337.dist-info/RECORD,,