honeybee-radiance-postprocess 0.4.314__tar.gz → 0.4.315__tar.gz

{honeybee-radiance-postprocess-0.4.314 → honeybee-radiance-postprocess-0.4.315}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.314
+Version: 0.4.315
 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.314 → honeybee-radiance-postprocess-0.4.315}/honeybee_radiance_postprocess/cli/postprocess.py

@@ -492,6 +492,62 @@ def annual_to_data(
         sys.exit(0)
 
 
+@post_process.command('point-in-time')
+@click.argument(
+    'folder',
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True)
+)
+@click.argument(
+    'hoy', type=click.FLOAT
+)
+@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(
+    '--sub-folder', '-sf', help='Optional relative path for subfolder to write output '
+    'metric files.', default='metrics'
+)
+def point_in_time(
+    folder, hoy, states, grids_filter, total, sub_folder
+):
+    """Get point in time values.
+
+    \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.
+        hoy: An HOY (point-in-time) for which to get the point-in-time values.
+    """
+    try:
+        if states:
+            states = DynamicSchedule.from_json(states)
+
+        res_type = 'total' if total is True else 'direct'
+
+        results = Results(folder)
+        results.point_in_time_to_folder(
+            sub_folder, datetime=hoy, states=states, grids_filter=grids_filter,
+            res_type=res_type)
+    except Exception:
+        _logger.exception('Failed to point in time values.')
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
 @post_process.command('annual-sunlight-exposure')
 @click.argument(
     'folder',

{honeybee-radiance-postprocess-0.4.314 → honeybee-radiance-postprocess-0.4.315}/honeybee_radiance_postprocess/results.py

@@ -690,13 +690,13 @@ class Results(_ResultsFolder):
         return total, grids_info
 
     def point_in_time(
-            self, datetime: Union[int, DateTime], states: DynamicSchedule = None,
+            self, datetime: Union[float, DateTime], states: DynamicSchedule = None,
             grids_filter: str = '*', res_type: str = 'total'
             ) -> type_hints.point_in_time:
         """Get point in time values.
 
         Args:
-            datetime: Hour of the as an integer or DateTime object.
+            datetime: Hour of the year as a float or DateTime object.
             states: A dictionary of states. Defaults to None.
             grids_filter: The name of a grid or a pattern to filter the grids.
                 Defaults to '*'.
@@ -707,7 +707,7 @@ class Results(_ResultsFolder):
         """
         grids_info = self._filter_grids(grids_filter=grids_filter)
 
-        if isinstance(datetime, int):
+        if isinstance(datetime, float):
             dt = DateTime.from_hoy(datetime)
         elif isinstance(datetime, DateTime):
             dt = datetime
@@ -732,6 +732,46 @@ class Results(_ResultsFolder):
 
         return pit_values, grids_info
 
+    def point_in_time_to_folder(
+            self, target_folder: str, datetime: Union[float, DateTime],
+            states: DynamicSchedule = None, grids_filter: str = '*',
+            res_type: str = 'total'
+            ) -> type_hints.point_in_time:
+        """Get point in time values and write the values to a folder.
+
+        Args:
+            target_folder: Folder path to write annual metrics in. Usually this
+                folder is called 'metrics'.
+            datetime: Hour of the year as a float or DateTime object.
+            states: A dictionary of states. Defaults to None.
+            grids_filter: The name of a grid or a pattern to filter the grids.
+                Defaults to '*'.
+            res_type: Type of results to load. Defaults to 'total'.
+
+        Returns:
+            Tuple: A tuple with point in time values and grid information.
+        """
+        folder = Path(target_folder)
+        folder.mkdir(parents=True, exist_ok=True)
+
+        pit_values, grids_info = self.point_in_time(
+            datetime=datetime, states=states,
+            grids_filter=grids_filter, res_type=res_type)
+
+        metric_folder = folder.joinpath('point_in_time')
+
+        for count, grid_info in enumerate(grids_info):
+            d = pit_values[count]
+            full_id = grid_info['full_id']
+            output_file = metric_folder.joinpath(f'{full_id}.pit')
+            output_file.parent.mkdir(parents=True, exist_ok=True)
+            np.savetxt(output_file, d, fmt='%.2f')
+
+        info_file = metric_folder.joinpath('grids_info.json')
+        info_file.write_text(json.dumps(grids_info))
+
+        return pit_values, grids_info
+
     def average_values(
             self, hoys: list = [], states: DynamicSchedule = None, grids_filter: str = '*',
             res_type: str = 'total') -> type_hints.average_values:

{honeybee-radiance-postprocess-0.4.314 → honeybee-radiance-postprocess-0.4.315}/honeybee_radiance_postprocess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-radiance-postprocess
-Version: 0.4.314
+Version: 0.4.315
 Summary: Postprocessing of Radiance results and matrices
 Home-page: https://github.com/ladybug-tools/honeybee-radiance-postprocess
 Author: Ladybug Tools