honeybee-radiance-folder


Namehoneybee-radiance-folder JSON
Version 2.11.15 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/honeybee-radiance-folder
SummaryHoneybee Radiance folder is a Python library to read, write and validate Radiance folder structure.
upload_time2024-06-24 15:45:50
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # honeybee-radiance-folder
[![Build Status](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder.svg?branch=master)](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-radiance-folder/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-radiance-folder)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
[![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/)

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/90/1b/6445b3d223df68dda38625ddb58abc5fc55fb10acb971e70cc986b0b1e79/honeybee-radiance-folder-2.11.15.tar.gz",
    "platform": null,
    "description": "# honeybee-radiance-folder\n[![Build Status](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder.svg?branch=master)](https://travis-ci.com/ladybug-tools/honeybee-radiance-folder)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-radiance-folder/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-radiance-folder)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)\n[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)\n[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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.15",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/honeybee-radiance-folder"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb155301e315ccf2f37fa2c328951d772fc700237c1ac64a78e6603a3164dae9",
                "md5": "3bc10e410917c7eb07f3ac9d885d9720",
                "sha256": "34cfd03089415a60e5542c68b2aace6dfba5f88cac0e7664bf3c45ded57b0cc1"
            },
            "downloads": -1,
            "filename": "honeybee_radiance_folder-2.11.15-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3bc10e410917c7eb07f3ac9d885d9720",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 21759,
            "upload_time": "2024-06-24T15:45:49",
            "upload_time_iso_8601": "2024-06-24T15:45:49.227064Z",
            "url": "https://files.pythonhosted.org/packages/fb/15/5301e315ccf2f37fa2c328951d772fc700237c1ac64a78e6603a3164dae9/honeybee_radiance_folder-2.11.15-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "901b6445b3d223df68dda38625ddb58abc5fc55fb10acb971e70cc986b0b1e79",
                "md5": "f378f0c3d430894086b838ef3873d817",
                "sha256": "a78564bcc9cb410d799ae70666ce499c2dec8f6d05a17af87faa06a7facc1842"
            },
            "downloads": -1,
            "filename": "honeybee-radiance-folder-2.11.15.tar.gz",
            "has_sig": false,
            "md5_digest": "f378f0c3d430894086b838ef3873d817",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20455,
            "upload_time": "2024-06-24T15:45:50",
            "upload_time_iso_8601": "2024-06-24T15:45:50.783700Z",
            "url": "https://files.pythonhosted.org/packages/90/1b/6445b3d223df68dda38625ddb58abc5fc55fb10acb971e70cc986b0b1e79/honeybee-radiance-folder-2.11.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-24 15:45:50",
    "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"
}
        
Elapsed time: 0.53500s