honeybee-radiance 1.66.94__tar.gz → 1.66.215__tar.gz

{honeybee-radiance-1.66.94 → honeybee_radiance-1.66.215}/PKG-INFO

@@ -1,19 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: honeybee-radiance
-Version: 1.66.94
+Version: 1.66.215
 Summary: Daylight and light simulation extension for honeybee.
 Home-page: https://github.com/ladybug-tools/honeybee-radiance
 Author: Ladybug Tools
 Author-email: info@ladybug.tools
 License: AGPL-3.0
 Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: Implementation :: IronPython
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: honeybee-core==1.64.8
+Requires-Dist: honeybee-radiance-folder==2.11.16
+Requires-Dist: honeybee-radiance-command==1.22.5
+Requires-Dist: honeybee-standards==2.0.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # honeybee-radiance
 
@@ -27,9 +45,9 @@ License-File: LICENSE
 [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)
 [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
 
-Radiance extension for honeybee
+Radiance extension for honeybee.
 
-Honeybee-radiance adds radiance functionalities to honeybee for daylight simulation.
+Honeybee-radiance adds Radiance simulation functionalities to honeybee for daylight/radiation simulation.
 
 ## Installation
 
@@ -40,3 +58,32 @@ To check if the command line interface is installed correctly use `honeybee-radi
 ## Documentation
 
 [API documentation](https://www.ladybug.tools/honeybee-radiance/docs/)
+
+## Local Development
+
+1. Clone this repo locally
+```console
+git clone git@github.com:ladybug-tools/honeybee-radiance
+
+# or
+
+git clone https://github.com/ladybug-tools/honeybee-radiance
+```
+2. Install dependencies:
+```console
+cd honeybee-radiance
+pip install -r dev-requirements.txt
+pip install -r requirements.txt
+```
+
+3. Run Tests:
+```console
+python -m pytest tests/
+```
+
+4. Generate Documentation:
+```console
+sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_radiance
+sphinx-build -b html ./docs ./docs/_build/docs
+```
+

{honeybee-radiance-1.66.94 → honeybee_radiance-1.66.215}/README.md

@@ -10,9 +10,9 @@
 [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)
 [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
 
-Radiance extension for honeybee
+Radiance extension for honeybee.
 
-Honeybee-radiance adds radiance functionalities to honeybee for daylight simulation.
+Honeybee-radiance adds Radiance simulation functionalities to honeybee for daylight/radiation simulation.
 
 ## Installation
 
@@ -23,3 +23,32 @@ To check if the command line interface is installed correctly use `honeybee-radi
 ## Documentation
 
 [API documentation](https://www.ladybug.tools/honeybee-radiance/docs/)
+
+## Local Development
+
+1. Clone this repo locally
+```console
+git clone git@github.com:ladybug-tools/honeybee-radiance
+
+# or
+
+git clone https://github.com/ladybug-tools/honeybee-radiance
+```
+2. Install dependencies:
+```console
+cd honeybee-radiance
+pip install -r dev-requirements.txt
+pip install -r requirements.txt
+```
+
+3. Run Tests:
+```console
+python -m pytest tests/
+```
+
+4. Generate Documentation:
+```console
+sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_radiance
+sphinx-build -b html ./docs ./docs/_build/docs
+```
+

honeybee_radiance-1.66.215/dev-requirements.txt

@@ -0,0 +1,19 @@
+pytest==8.3.2;python_version>='3.6'
+Sphinx==8.0.2;python_version>='3.6'
+sphinx-bootstrap-theme==0.8.1
+sphinxcontrib-fulltoc==1.2.0
+sphinxcontrib-websupport==2.0.0;python_version>='3.6'
+sphinx-click==6.0.0;python_version>='3.6'
+twine==6.1.0;python_version>='3.6'
+wheel==0.45.1;python_version>='3.6'
+setuptools==80.9.0;python_version>='3.6'
+build==1.3.0;python_version>='3.6'
+pytest==4.6.9;python_version<'3.0'
+Sphinx==1.8.5;python_version<'3.0'
+sphinxcontrib-websupport==1.1.2;python_version<'3.0'
+sphinx-click==4.4.0;python_version<'3.0'
+twine==1.13.0;python_version<'3.0'
+wheel==0.38.1;python_version<'3.0'
+setuptools==44.1.0;python_version<'3.0'
+build==0.1.0;python_version<'3.0'
+importlib-metadata==2.0.0;python_version<'3.0'

{honeybee-radiance-1.66.94 → honeybee_radiance-1.66.215}/honeybee_radiance/cli/__init__.py

@@ -25,6 +25,7 @@ from .multiphase import multi_phase
 from .glare import dcglare
 from .schedule import schedule
 from .study import study
+from .modifier import modifier
 
 
 _logger = logging.getLogger(__name__)
@@ -81,6 +82,7 @@ radiance.add_command(multi_phase)
 radiance.add_command(dcglare)
 radiance.add_command(schedule)
 radiance.add_command(study)
+radiance.add_command(modifier)
 
 # add radiance sub-commands to honeybee CLI
 main.add_command(radiance)

{honeybee-radiance-1.66.94 → honeybee_radiance-1.66.215}/honeybee_radiance/cli/dc.py

@@ -21,13 +21,13 @@ def dc():
 
 @dc.command('scontrib')
 @click.argument(
-    'octree', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+    'octree', type=click.Path(exists=True, file_okay=True)
 )
 @click.argument(
-    'sensor-grid', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+    'sensor-grid', type=click.Path(exists=True, file_okay=True)
 )
 @click.argument(
-    'modifiers', type=click.Path(exists=True, file_okay=True, resolve_path=True)
+    'modifiers', type=click.Path(exists=True, file_okay=True)
 )
 @click.option(
     '--sensor-count', type=click.INT, show_default=True,
@@ -118,12 +118,15 @@ def rcontrib_command_with_postprocess(
         else:
             options.update_from_string('-aa 0.0 -V+ -y {}'.format(sensor_count))
 
-        options.M = modifiers
-        # create command.
-        rcontrib = Rcontrib(
-            options=options, octree=octree, sensors=sensor_grid
-        )
-        cmd = rcontrib.to_radiance().replace('\\', '/')
+        modifiers = os.path.relpath(modifiers)
+        if modifiers.startswith('..'):
+            pass
+        else:
+            modifiers = f'./{modifiers}'
+        cmd = 'rcontrib {options} -M {modifiers} {octree} < {sensor_grid}'.format(
+            options=options.to_radiance(),
+            modifiers=modifiers, octree=octree, sensor_grid=sensor_grid)
+        cmd = cmd.replace("\\", "/")
 
         if conversion and conversion.strip():
             if multiply_by != 1:

{honeybee-radiance-1.66.94 → honeybee_radiance-1.66.215}/honeybee_radiance/cli/glare.py

@@ -18,13 +18,20 @@ def dcglare():
 
 @dcglare.command('two-phase')
 @click.argument(
-    'dc-direct', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+    'dc-direct',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
 @click.argument(
-    'dc-total', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+    'dc-total',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
 @click.argument(
-    'sky-mtx', type=click.Path(exists=True, dir_okay=False, resolve_path=True))
+    'sky-mtx',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
+)
 @click.argument(
-    'view-rays', type=click.Path(exists=True, dir_okay=False, resolve_path=True)
+    'view-rays',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True)
 )
 @click.option(
     '--glare-limit', '-l', type=float,
@@ -51,7 +58,8 @@ def dcglare():
     '--glare-limit (or -l) is specified.'
 )
 @click.option(
-    '--output', '-o', help='Path to output file. If a relative path is provided it '
+    '--output', '-o', default='output.dgp',
+    help='Path to output file. If a relative path is provided it '
     'should be relative to project folder.'
 )
 @click.option(
@@ -84,11 +92,13 @@ def two_phase_command(
             options.b = threshold_factor
         if occupancy_schedule:
             options.sf = occupancy_schedule
-
-        # create command.
+        # create command
+        out_dir = os.path.dirname(output)
+        if out_dir and not os.path.isdir(out_dir):
+            os.makedirs(out_dir)
         dcglare = Dcglare(
-            options=options, output=output, dc_direct=dc_direct, dc_total=dc_total,
-            sky_matrix=sky_mtx
+            options=options, output=output,
+            dc_direct=dc_direct, dc_total=dc_total, sky_matrix=sky_mtx
         )
 
         if dry_run:

honeybee_radiance-1.66.215/honeybee_radiance/cli/modifier.py

@@ -0,0 +1,133 @@
+"""honeybee radiance modifier commands."""
+import click
+import sys
+import os
+import logging
+import json
+
+from honeybee_radiance.sensorgrid import SensorGrid
+
+
+_logger = logging.getLogger(__name__)
+
+
+@click.group(help='Commands for generating and modifying Radiance modifiers.')
+def modifier():
+    pass
+
+
+@modifier.command('split-modifiers')
+@click.argument('modifier-file', type=click.Path(
+    exists=True, file_okay=True, dir_okay=False, resolve_path=True))
+@click.argument(
+    'output-folder',
+    type=click.Path(file_okay=False, dir_okay=True, resolve_path=True))
+@click.option(
+    '--sensor-count', '-sc', help='The number of sensors in the sensor grid '
+    'that will be used in rcontrib with the distributed modifiers.', 
+    type=int, default=5000, show_default=True)
+@click.option(
+    '--grid-file', '-gf', help='Full path to a sensor grid file. This file '
+    'is used to count the number of sensors and will override the '
+    '--sensor-count option.',
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True),
+    default=None, show_default=True)
+@click.option(
+    '--max-value', '-max', help='An optional integer to define the maximum value '
+    'allowed when multiplying the number of sensors with the number of modifiers '
+    'in the distributed modifiers. Default: 40000000.',
+    type=int, default=40000000, show_default=True)
+@click.option(
+    '--sensor-multiplier', '-d', help='An optional integer to be multiplied by '
+    'the grid count to yield a final number of the sensor count. This is useful '
+    'in workflows where the sensor grids are modified such as when calculating '
+    'view factor. Default: 1.', type=int, default=1)
+def split_modifiers(
+    modifier_file, output_folder, sensor_count, grid_file, max_value,
+    sensor_multiplier
+):
+    """Split a list of modifiers into multiple files.
+
+    This command splits the modifiers based on the sensor count and the max value.
+    The max value is divided by the sensor count to calculate the maximum number
+    of modifiers in each distributed file of modifiers.
+
+    This command creates a new folder with evenly distributed modifiers. The folder
+    will include a ``_dist_info.json`` file which has the information to recreate the
+    original input files from this folder and the results generated based on the modifiers
+    in this folder.
+
+    ``_redist_info.json`` file includes an array of JSON objects. Each object has
+    the distribution information, which in comparison to the command to split grids
+    is much simpler.
+
+    \b
+    Args:
+        modifier_file: Full path to a file with Radiance modifiers. The modifiers
+            must be the identifiers of the modifiers and not the actual Radiance
+            description of the modifiers.
+        output_folder: A new folder to write the newly created files.
+    """
+    try:
+        if grid_file:
+            sg = SensorGrid.from_file(grid_file)
+            sensor_count = sg.count
+        sensor_count *= sensor_multiplier
+
+        with open(modifier_file, 'r') as file:
+            modifiers = [modifier.strip() for modifier in file.readlines()]
+
+        modifier_count = len(modifiers)
+
+        max_lines_per_file = int(max_value / sensor_count)
+        lines_per_file = max(1, max_lines_per_file)
+        dist_count = int(len(modifiers) / lines_per_file)
+        if len(modifiers) % lines_per_file != 0:
+            dist_count += 1
+
+        mod_per_dist = int(round(modifier_count / dist_count)) or 1
+
+        # create output folder
+        if not os.path.isdir(output_folder):
+            os.mkdir(output_folder)
+
+        remainder = modifier_count % dist_count  # extra lines to distribute
+
+        start_index = 0
+        dist_info = []
+        out_dist_info = []
+        for i in range(dist_count):
+            end_index = start_index + mod_per_dist + (1 if i <= remainder else 0)
+
+            lines_to_write = modifiers[start_index:end_index]
+
+            dist_info.append(
+                {
+                    'dist_info': [{'identifier': i}]
+                }
+            )
+            out_dist_info.append(
+                {
+                    'identifier': str(i),
+                    'count': len(lines_to_write)
+                }
+            )
+            # create a file and write the lines
+            with open(os.path.join(output_folder, '%s.mod' % i), 'w') as f:
+                f.write('\n'.join(lines_to_write))
+
+            # update the start index for the next iteration
+            start_index = end_index
+
+        dist_info_file = os.path.join(output_folder, '_redist_info.json')
+        with open(dist_info_file, 'w') as dist_out_file:
+            json.dump(dist_info, dist_out_file, indent=2)
+
+        dist_info_file = os.path.join(output_folder, '_info.json')
+        with open(dist_info_file, 'w') as dist_out_file:
+            json.dump(out_dist_info, dist_out_file, indent=2)
+    except Exception:
+        _logger.exception('Failed to distribute sensor grids in folder.')
+        sys.exit(1)
+    else:
+        sys.exit(0)