Skip to content

Commit

Permalink
feat(combined receiver): Clarified the intent of the combined receiver
Browse files Browse the repository at this point in the history
This is mostly to trigger a release so that all the other libraries have access to the dictionary containing receivers. Improved the documentation in the process.
  • Loading branch information
built-test authored and built-tools committed Jan 26, 2022
1 parent 550c7b4 commit 62a7b7e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions honeybee_radiance_folder/folder.py
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,9 @@ def combined_receivers(self, folder='receivers', auto_mtx_path=True):
folder: A path of the target folder to write files to (default: 'receivers').
auto_mtx_path: If set to True, then the path of the view matrices will be
specified automatically.
Returns:
A dictionary containing grid identifiers as keys and the receiver rad files
as values.
"""
grids = self.grid_data_all()
apt_group_folder = self.aperture_group_folder(full=False)
Expand Down
2 changes: 2 additions & 0 deletions honeybee_radiance_folder/folderutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,8 @@ def combined_receiver(grid_name, apt_group_folder, apt_groups, target_folder,
target_folder: A path of the target folder to write files to.
add_output_header: If set to True, a header will be added to redirect the
generated view matrix to the path specified through the "o= .." option.
Returns:
The path of the file that was written out as the combined receiver.
"""
file_name = '%s..receiver.rad' % grid_name
apt_group_folder = apt_group_folder.replace('\\', '/')
Expand Down

0 comments on commit 62a7b7e

Please sign in to comment.