honeybee-radiance-postprocess 0.4.554__tar.gz → 0.4.591__tar.gz

honeybee_radiance_postprocess-0.4.591/CUPY.MD

@@ -0,0 +1,88 @@
+# CuPy installation guide
+
+## :white_check_mark: CuPy requirements
+
+* You have an NVIDIA GPU.
+* Your GPU's compute capability is supported by CuPy.
+* You have a suitable CUDA Toolkit installed (matching the CuPy package variant).
+* Your GPU driver supports the CUDA version you intend to use.
+
+## :wrench: Compute Capability
+
+### What is Compute Capability
+Compute capability is a number that describes the feature set and performance characteristics of your NVIDIA GPU architecture.
+
+CuPy supports GPUs with compute capability ≥ 3.0.
+
+Examples:
+* NVIDIA GTX 1080 → Compute Capability **6.1**.
+* NVIDIA GTX 2080 → Compute Capability **7.5**.
+* NVIDIA RTX 3080 → Compute Capability **8.6**.
+* NVIDIA RTX 4090 → Compute Capability **8.9**.
+* NVIDIA RTX 5090 → Compute Capability **12.0**.
+
+You can find the compute capability of your GPU [here](https://developer.nvidia.com/cuda-gpus). If you have an older GPU, such as the GTX 10 series or older, please check [this](https://developer.nvidia.com/cuda-legacy-gpus) list.
+
+If you are still not sure about your compute capability, you can query it through CuPy once it is installed:
+
+```python
+import cupy as cp
+
+print(cp.cuda.Device().compute_capability)
+```
+
+This prints the major index and minor index as a string, e.g., '75' for version 7.5.
+
+## :toolbox: CUDA Toolkit
+
+### What is CUDA Toolkit
+The CUDA Toolkit provides the underlying CUDA libraries, runtime, and compiler that CuPy uses to run GPU code. CuPy depends on a matching CUDA Toolkit and GPU driver that supports your GPU.
+
+### Picking the correct CUDA version
+
+You can find the CUDA version supported by your GPU driver by executing  [nvidia-smi](https://docs.nvidia.com/deploy/nvidia-smi/index.html) in the command prompt.
+
+```
+C:\Users\USERNAME>nvidia-smi
++-----------------------------------------------------------------------------------------+
+| NVIDIA-SMI 581.80                 Driver Version: 581.80         CUDA Version: 13.0     |
++-----------------------------------------+------------------------+----------------------+
+```
+
+Please note that the CUDA version reported by nvidia-smi is not the installed version of the CUDA Toolkit; it is the latest API compatible version for your GPU driver. If your GPU driver is not up to date you might not see the latest CUDA version.
+
+### Installing CUDA Toolkit
+
+You can download the latest version of CUDA Toolkit [here](https://developer.nvidia.com/cuda-downloads). If your GPU driver does not support the latest version, you can select a compatible version in the [archive](https://developer.nvidia.com/cuda-toolkit-archive).
+
+## :package: Installing CuPy
+
+CuPy provides prebuilt binary wheels tied to CUDA versions. You should install the wheel matching your installed CUDA Toolkit.
+
+| CUDA Toolkit	      | Command                  |
+| ------------------- | ------------------------ |
+| CUDA 13.x	          | pip install cupy-cuda13x |
+| CUDA 12.x      	  | pip install cupy-cuda12x |
+| CUDA 11.x (>= 11.2) |	pip install cupy-cuda11x |
+
+## :question: FAQ
+
+### Can I use CuPy with an AMD GPU?
+
+If you have an AMD GPU please read [this](https://docs.cupy.dev/en/stable/install.html#using-cupy-on-amd-gpu-experimental).
+
+### How can I tell if honeybee-radiance-process is using CuPy and not NumPy?
+
+honeybee-radiance-postprocess will print a line that tells you if CuPy is being used. You should see something like this:
+
+`Using CuPy (13.6.0) for GPU (NVIDIA GeForce RTX 3080) acceleration in honeybee-radiance-postprocess.`
+
+If CuPy *is* installed but fails during initialization honeybee-radiance-postprocess will fall back to NumPy. If this happens you should see a statement similar to this:
+
+`Failed to load CuPy successfully. Falling back to NumPy (1.26.4) in honeybee-radiance-postprocess`
+
+## :warning: Common Errors
+
+`FileNotFoundError: Could not find module 'nvrtc64_130_0.dll' (or one of its dependencies). Try using the full path with constructor syntax.`
+
+This is possibly caused by a mismatch between the CUDA Toolkit version and the CuPy version, e.g., cupy-cuda13x and CUDA Toolkit 12.9.

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/PKG-INFO

@@ -1,20 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: honeybee-radiance-postprocess
-Version: 0.4.554
+Version: 0.4.591
 Summary: Postprocessing of Radiance results and matrices
 Home-page: https://github.com/ladybug-tools/honeybee-radiance-postprocess
 Author: Ladybug Tools
 Author-email: info@ladybug.tools
 License: GPLv3
-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 General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: honeybee-radiance==1.66.190
+Requires-Dist: honeybee-radiance==1.66.221
 Requires-Dist: numpy<2.0.0
+Requires-Dist: cupy-cuda12x==13.6.0
+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
 
 [![Build Status](https://github.com/ladybug-tools/honeybee-radiance-postprocess/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/honeybee-radiance-postprocess/actions)
 [![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-radiance-postprocess/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-radiance-postprocess)

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/dev-requirements.txt

@@ -5,10 +5,10 @@ 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==5.1.1;python_version>='3.6'
-wheel==0.44.0;python_version>='3.6'
-setuptools==75.1.0;python_version>='3.6'
-importlib-metadata==8.5.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'
@@ -16,4 +16,5 @@ 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_postprocess-0.4.591/honeybee_radiance_postprocess/__init__.py

@@ -0,0 +1,36 @@
+"""honeybee-radiance-postprocess library."""
+import sys
+
+IS_GPU = False
+
+if sys.version_info >= (3, 0):
+    try:
+        import cupy as np
+        np.arange(1)
+        IS_GPU = True
+        try:
+            device_id = np.cuda.runtime.getDevice()
+            device_props = np.cuda.runtime.getDeviceProperties(device_id)
+            device_name = device_props['name'].decode()
+        except Exception:
+            device_name = 'Unknown GPU'
+
+        msg = (
+            'Using CuPy ({}) for GPU ({}) acceleration in '
+            'honeybee-radiance-postprocess.'
+        ).format(np.__version__, device_name)
+        sys.stderr.write(msg)
+
+    except ModuleNotFoundError:
+        import numpy as np
+
+    except Exception as e:
+        import numpy as np
+        msg = (
+            'Failed to load CuPy successfully. '
+            'Help: https://github.com/ladybug-tools/honeybee-radiance-postprocess/blob/master/CUPY.md. '
+            'Falling back to NumPy ({}) in honeybee-radiance-postprocess: {}'
+        ).format(np.__version__, e)
+        sys.stderr.write(msg)
+
+IS_CPU = not IS_GPU

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/annual.py

@@ -1,16 +1,10 @@
 """Shared functions for post-processing annual results."""
 from typing import Union
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
 from ladybug.analysisperiod import AnalysisPeriod
-from .util import filter_array
 
-is_cpu = not is_gpu
+from . import np
+from .util import filter_array
 
 
 def occupancy_schedule_8_to_6(

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/annualdaylight.py

@@ -1,15 +1,6 @@
-"""Functions for post-processing annual daylight outputs.
-
-Note: These functions will most likely be moved to a separate package in the near future.
-"""
+"""Functions for post-processing annual daylight outputs."""
 import json
 import os
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
 from ladybug.color import Colorset
 from ladybug.datatype.fraction import Fraction
@@ -17,6 +8,7 @@ from ladybug.legend import LegendParameters
 from honeybee_radiance.postprocess.annual import filter_schedule_by_hours, \
     _process_input_folder
 
+from . import np
 from .metrics import da_array2d, cda_array2d, udi_array2d, \
     udi_lower_array2d, udi_upper_array2d
 from .util import filter_array

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/annualirradiance.py

@@ -1,5 +1,4 @@
 """Functions for post-processing annual irradiance outputs."""
-
 from ladybug.datatype.energyflux import EnergyFlux
 from ladybug.datatype.energyintensity import EnergyIntensity
 from ladybug.legend import LegendParameters

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/breeam/breeam.py

@@ -2,16 +2,11 @@
 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 .. import np
 from ..results.annual_daylight import AnnualDaylight
 
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/abnt.py

@@ -4,18 +4,13 @@ import sys
 import logging
 from pathlib import Path
 import click
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
 from honeybee.model import Model
 from honeybee.room import Room
 from ladybug_geometry.geometry3d.face import Face3D
 from ladybug_geometry.geometry3d.pointvector import Vector3D
 
+from .. import np
 from ..vis_metadata import _abnt_nbr_15575_daylight_levels_vis_metadata
 
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/datacollection.py

@@ -1,21 +1,17 @@
 """Commands to work with data collections."""
 import sys
 import logging
+import json
 from pathlib import Path
 import click
-import json
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
 from ladybug.datacollection import HourlyContinuousCollection, \
     HourlyDiscontinuousCollection
 from ladybug.header import Header
 from ladybug.datautil import collections_to_csv
 
+from .. import np
+
 
 _logger = logging.getLogger(__name__)
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/grid.py

@@ -1,17 +1,13 @@
 """honeybee radiance postprocess grid commands."""
-import click
 import sys
 import logging
 import json
 from pathlib import Path
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+import click
 
 from honeybee_radiance_postprocess.reader import binary_to_array
+
+from .. import np
 from ..annualdaylight import _annual_daylight_vis_metadata
 
 _logger = logging.getLogger(__name__)

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/merge.py

@@ -1,18 +1,14 @@
 """honeybee radiance postprocess merge commands."""
-import click
 import sys
 import logging
 import json
 from pathlib import Path
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+import click
 
 from honeybee_radiance_postprocess.reader import binary_to_array
 
+from .. import np
+
 _logger = logging.getLogger(__name__)
 
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/mtxop.py

@@ -3,13 +3,8 @@ import sys
 import logging
 from pathlib import Path
 import click
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
+from .. import np
 from ..reader import binary_to_array, ascii_to_array
 
 _logger = logging.getLogger(__name__)

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/postprocess.py

@@ -5,21 +5,15 @@ import os
 import logging
 import json
 import click
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
 from ladybug.location import Location
 from ladybug.wea import Wea
-from honeybee_radiance_postprocess.results.annual_daylight import AnnualDaylight
-from honeybee_radiance_postprocess.results.annual_irradiance import AnnualIrradiance
+from honeybee_radiance_postprocess.results import AnnualDaylight, AnnualIrradiance
 from honeybee_radiance_postprocess.metrics import da_array2d, cda_array2d, \
     udi_array2d, udi_lower_array2d, udi_upper_array2d
 from honeybee_radiance_postprocess.reader import binary_to_array
 
+from .. import np
 from ..annual import occupancy_schedule_8_to_6
 from ..dynamic import DynamicSchedule
 from ..en17037 import en17037_to_folder
@@ -505,6 +499,89 @@ def annual_to_data(
         sys.exit(0)
 
 
+@post_process.command('annual-statistics')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.option(
+    '--hoys-file', '-h', help='Path to an HOYs file. Values must be separated by '
+    'new line. If not provided the data will not be filtered by HOYs.',
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--states', '-st', help='A JSON file with a dictionary of states. If states '
+    'are not provided the default states will be used for any aperture groups.',
+    default=None, show_default=True,
+    type=click.Path(exists=False, file_okay=True, dir_okay=False, resolve_path=True)
+)
+@click.option(
+    '--grids-filter', '-gf', help='A pattern to filter the grids.', default='*',
+    show_default=True
+)
+@click.option(
+    '--total/--direct', is_flag=True, default=True, help='Switch between total '
+    'and direct results. Default is total.'
+)
+@click.option(
+    '--sensor/--timestep', is_flag=True, default=True, help='Switch between results '
+    'for each sensor or timestep. Default is sensor.'
+)
+
+@click.option(
+    '--sub-folder', '-sf', help='Optional relative path for subfolder to write output '
+    'statistics files.', default='statistics'
+)
+def annual_statistics(
+    folder, hoys_file, states, grids_filter, total, sensor, sub_folder
+):
+    """Get annual statistics (average, median, minimum, maximum, cumulative).
+
+    \b
+    Args:
+        folder: Results folder. This folder is an output folder of annual daylight
+            recipe. Folder should include grids_info.json and sun-up-hours.txt. The
+            command uses the list in grids_info.json to find the result files for each
+            sensor grid.
+    """
+    try:
+        if hoys_file:
+            with open(hoys_file) as hoys:
+                hoys = [float(h) for h in hoys.readlines()]
+        else:
+            hoys = []
+
+        if states:
+            states = DynamicSchedule.from_json(states)
+
+        res_type = 'total' if total is True else 'direct'
+
+        axis = 1 if sensor is True else 0
+
+        study_info_file = Path(folder).joinpath('study_info.json')
+        if study_info_file.exists():
+            with open(study_info_file) as file:
+                study_info = json.load(file)
+            study_type = study_info.get('study_type', 'annual-daylight')
+        else:
+            study_type = 'annual-daylight'
+
+        if study_type == 'annual-daylight':
+            results = AnnualDaylight(folder)
+        elif study_type == 'annual-irradiance':
+            results = AnnualIrradiance(folder)
+        else:
+            raise ValueError(f'Unknown study type: {study_type}.')
+        results.annual_statistics_to_folder(
+            sub_folder, hoys=hoys, states=states, grids_filter=grids_filter,
+            res_type=res_type, axis=axis)
+    except Exception:
+        _logger.exception('Failed to calculate annual statistics.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
 @post_process.command('point-in-time')
 @click.argument(
     'folder',
@@ -1030,7 +1107,7 @@ def convert_matrix_to_binary(
         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)

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/translate.py

@@ -3,15 +3,10 @@ import sys
 import logging
 from pathlib import Path
 import shutil
-import click
 import json
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+import click
 
+from .. import np
 from ..reader import binary_to_array
 from ..util import get_delimiter
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/two_phase.py

@@ -3,13 +3,8 @@ import sys
 import logging
 from pathlib import Path
 import click
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
 
+from .. import np
 from ..reader import binary_to_array, ascii_to_array
 
 _logger = logging.getLogger(__name__)

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/util.py

@@ -1,7 +1,8 @@
-from ladybug.analysisperiod import AnalysisPeriod
 from datetime import datetime
 import copy
 
+from ladybug.analysisperiod import AnalysisPeriod
+
 
 def get_hoys(start_date, start_time, end_date, end_time, timestep, leap_year):
     """Return list of hours from start date, star hour, end date and end hour.

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/viewfactor.py

@@ -1,15 +1,9 @@
 """Commands to compute view factors to geometry."""
-import click
 import os
 import sys
 import logging
 import math
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+import click
 
 from honeybee_radiance.config import folders
 
@@ -20,6 +14,8 @@ from ladybug.futil import preparedir
 
 from honeybee_radiance_postprocess.reader import binary_to_array
 
+from .. import np
+
 _logger = logging.getLogger(__name__)
 
 

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/cli/well.py

@@ -83,7 +83,7 @@ def well_daylight_vis(output_folder):
     metric_info_dict = {
         'L01': {
             'type': 'VisualizationMetaData',
-            'data_type': GenericType('sDA200,40%', '').to_dict(),
+            'data_type': GenericType('sDA150,50%', '').to_dict(),
             'unit': '',
             'legend_parameters': pass_fail_lpar.to_dict()
         },

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/data_type.py

@@ -1,11 +1,7 @@
 """Functions for NumPy data type (dtype)."""
 from typing import Tuple
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+
+from . import np
 
 
 def smallest_integer_dtype(array: np.ndarray) -> np.signedinteger:

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/electriclight.py

@@ -1,11 +1,6 @@
 """Functions for post-processing daylight outputs into electric lighting schedules."""
 from typing import List
-try:
-    import cupy as np
-    is_gpu = True
-except ImportError:
-    is_gpu = False
-    import numpy as np
+from . import np
 
 
 def array_to_dimming_fraction(

{honeybee_radiance_postprocess-0.4.554 → honeybee_radiance_postprocess-0.4.591}/honeybee_radiance_postprocess/en17037.py

@@ -2,17 +2,12 @@
 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 ladybug.color import Colorset
 from ladybug.datatype.fraction import Fraction
 from ladybug.legend import LegendParameters
 
+from . import np
 from .results.annual_daylight import AnnualDaylight
 from .dynamic import DynamicSchedule
 from .metrics import da_array2d