# honeybee-radiance-folder
[](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder)
[](https://coveralls.io/github/ladybug-tools/honeybee-radiance-folder)
[](https://www.python.org/downloads/release/python-370/)
[](https://www.python.org/downloads/release/python-270/)
[](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
Honeybee Radiance Folder is a Python library to read, write and validate the
[Radiance folder structure](https://github.com/ladybug-tools/radiance-folder-structure).
# Installation
`pip install -U honeybee-radiance-folder`
# [API Documentation](https://www.ladybug.tools/honeybee-radiance-folder/docs/)
# Usage
```python
# create a Radiance Model folder
import os
from honeybee_radiance_folder import ModelFolder
rf = 'c:/ladybug/sample_folder'
folder = ModelFolder(rf)
folder.write(overwrite=True)
# check the folders and files created in model folder
for f in os.listdir(folder.model_folder(full=True)):
print(f)
```
```shell
aperture
folder.cfg
grid
scene
```
```python
# load a Radiance folder
# in this case we are loading the folder from sample folder in radiance folder repository
# you can download it from here
# https://github.com/ladybug-tools/radiance-folder-structure/tree/master/project_folder
from honeybee_radiance_folder import ModelFolder
radiance_folder = r'./tests/assets/project_folder'
folder = ModelFolder(radiance_folder)
# get input files for scene
for f in folder.scene_files(black_out=False, rel_path=True):
print(f)
```
```shell
model/scene/context.mat
model/scene/context.rad
model/scene/partition.mat
model/scene/partition.rad
model/scene/partition_glass.mat
model/scene/partition_glass.rad
model/scene/room_envelope.mat
model/scene/room_envelope.rad
```
```python
# and apertures
for f in folder.aperture_files(black_out=False, rel_path=True):
print(f)
```
```shell
model\aperture\aperture.mat
model\aperture\aperture.rad
```
```python
# and finally get aperture groups - south window in this case
# and check each state
for count, ap in enumerate(folder.aperture_groups(interior=False)):
print('Aperture group %d: %s' % (count + 1, ap.identifier))
for state in ap.states:
print('- %s: %s' % (state.identifier, state.default))
```
```shell
Aperture group 1: south_window
- 0_clear: south_window..default..000.rad
- 1_diffuse: south_window..default..001.rad
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-radiance-folder",
"name": "honeybee-radiance-folder",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/78/91/f62d5760c081d0a2f4d719ed4c76003c8a08879bddbaaa37a9d6e6d1873c/honeybee_radiance_folder-2.11.16.tar.gz",
"platform": null,
"description": "# honeybee-radiance-folder\n[](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder)\n[](https://coveralls.io/github/ladybug-tools/honeybee-radiance-folder)\n\n[](https://www.python.org/downloads/release/python-370/)\n[](https://www.python.org/downloads/release/python-270/)\n[](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\nHoneybee Radiance Folder is a Python library to read, write and validate the\n[Radiance folder structure](https://github.com/ladybug-tools/radiance-folder-structure).\n\n# Installation\n\n`pip install -U honeybee-radiance-folder`\n\n# [API Documentation](https://www.ladybug.tools/honeybee-radiance-folder/docs/)\n\n# Usage\n\n```python\n# create a Radiance Model folder\nimport os\nfrom honeybee_radiance_folder import ModelFolder\n\nrf = 'c:/ladybug/sample_folder'\nfolder = ModelFolder(rf)\nfolder.write(overwrite=True)\n\n# check the folders and files created in model folder\nfor f in os.listdir(folder.model_folder(full=True)):\n print(f)\n```\n\n```shell\naperture\nfolder.cfg\ngrid\nscene\n```\n\n```python\n# load a Radiance folder\n\n# in this case we are loading the folder from sample folder in radiance folder repository\n# you can download it from here\n# https://github.com/ladybug-tools/radiance-folder-structure/tree/master/project_folder\nfrom honeybee_radiance_folder import ModelFolder\n\nradiance_folder = r'./tests/assets/project_folder'\nfolder = ModelFolder(radiance_folder)\n\n# get input files for scene\nfor f in folder.scene_files(black_out=False, rel_path=True):\n print(f)\n```\n\n```shell\nmodel/scene/context.mat\nmodel/scene/context.rad\nmodel/scene/partition.mat\nmodel/scene/partition.rad\nmodel/scene/partition_glass.mat\nmodel/scene/partition_glass.rad\nmodel/scene/room_envelope.mat\nmodel/scene/room_envelope.rad\n```\n\n```python\n# and apertures\nfor f in folder.aperture_files(black_out=False, rel_path=True):\n print(f)\n```\n\n```shell\nmodel\\aperture\\aperture.mat\nmodel\\aperture\\aperture.rad\n```\n\n```python\n# and finally get aperture groups - south window in this case\n# and check each state\nfor count, ap in enumerate(folder.aperture_groups(interior=False)):\n print('Aperture group %d: %s' % (count + 1, ap.identifier))\n for state in ap.states:\n print('- %s: %s' % (state.identifier, state.default))\n```\n\n```shell\nAperture group 1: south_window\n- 0_clear: south_window..default..000.rad\n- 1_diffuse: south_window..default..001.rad\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Honeybee Radiance folder is a Python library to read, write and validate Radiance folder structure.",
"version": "2.11.16",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-radiance-folder"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbd457f26aea6b515d7a69cdf87b86d89e6e11089c839a2b79fb4bedcd6bc7e4",
"md5": "1d4450dbd364f9280d9d6852b6482fd1",
"sha256": "263675678e46e6ba1be0b32c37f1c43599b9f41f2f44a93048c4350a63206604"
},
"downloads": -1,
"filename": "honeybee_radiance_folder-2.11.16-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d4450dbd364f9280d9d6852b6482fd1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 21771,
"upload_time": "2024-12-03T22:19:56",
"upload_time_iso_8601": "2024-12-03T22:19:56.575030Z",
"url": "https://files.pythonhosted.org/packages/bb/d4/57f26aea6b515d7a69cdf87b86d89e6e11089c839a2b79fb4bedcd6bc7e4/honeybee_radiance_folder-2.11.16-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7891f62d5760c081d0a2f4d719ed4c76003c8a08879bddbaaa37a9d6e6d1873c",
"md5": "7183e2a2d8f125a8de84d1e5e6a7fa09",
"sha256": "93e6833ff06475780c5fd1b10f3c503fe3dd5410194f94a27579d4142fdd942e"
},
"downloads": -1,
"filename": "honeybee_radiance_folder-2.11.16.tar.gz",
"has_sig": false,
"md5_digest": "7183e2a2d8f125a8de84d1e5e6a7fa09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20998,
"upload_time": "2024-12-03T22:19:58",
"upload_time_iso_8601": "2024-12-03T22:19:58.280691Z",
"url": "https://files.pythonhosted.org/packages/78/91/f62d5760c081d0a2f4d719ed4c76003c8a08879bddbaaa37a9d6e6d1873c/honeybee_radiance_folder-2.11.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 22:19:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-radiance-folder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "honeybee-radiance-folder"
}
JSON
