Skip to main content

Honeybee Radiance folder is a Python library to read, write and validate Radiance folder structure.

Project description

honeybee-radiance-folder

Build Status Coverage Status

Python 3.7 Python 2.7 IronPython

Honeybee Radiance Folder is a Python library to read, write and validate the Radiance folder structure.

Installation

pip install -U honeybee-radiance-folder

API Documentation

Usage

# 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)
aperture
folder.cfg
grid
scene
# 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)
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
# and apertures
for f in folder.aperture_files(black_out=False, rel_path=True):
    print(f)
model\aperture\aperture.mat
model\aperture\aperture.rad
# 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))
Aperture group 1: south_window
- 0_clear: south_window..default..000.rad
- 1_diffuse: south_window..default..001.rad

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for honeybee-radiance-folder, version 2.7.0
Filename, size File type Python version Upload date Hashes
Filename, size honeybee_radiance_folder-2.7.0-py2.py3-none-any.whl (18.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size honeybee-radiance-folder-2.7.0.tar.gz (867.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page