Skip to main content

No project description provided

Project description

Install + Test CodeQL Upload Python Package

frads: Framework for Radiance matrix-based simulation control (WIP)

This is the repository for frads development. Radiance is a free and open-source, raytracing-based lighting engine that is used extensively by engineering firms for innovative solar control, lighting, and daylighting design to improve the energy efficiency of buildings. With matrix algebraic methods, climate-based annual simulations can now be conducted in less than two minutes. frads automates setup of these simulations by providing end users with an open-source, high-level abstraction of the Radiance command-line workflow (Unix toolbox model), helping to reduce the steep learning curve and associated user errors. frads also provides the necessary infrastructure needed for seamless integration of Radiance and other modeling tools, such as EnergyPlus.


Contact/ Support

We welcome beta users of frads. Feel free to post questions and suggestions in the Discussion section of this GitHub site or contact the principal author at Information about Radiance can be found at: . The Radiance community is active and welcomes new users via the Radiance Discourse site or Unmet Hours.


frads uses Radiance tools in its implementation. Radiance models have been rigorously tested and validated using laboratory and outdoor field data, demonstrating its superior performance in delivering photometrically accurate, photorealistic results. Each Radiance commit and release is tested using the GitHub Action system. Unit tests were developed for most of the major Radiance programs. Tests are performed using Radiance radcompare, which was designed specifically to test Monte Carlo ray-tracing algorithms. Integration tests are the main type of test performed for frads commit and releases. These tests also use the GitHub Action system.


frads is a work in progress (see to-do list below). frads has been tested on the latest official release of Radiance (September 2020, v5.3) but may not have been tested on the latest HEAD release, which contains source code changes made as recently as yesterday. frads has also been tested on the latest official EnergyPlus release (> v9.3).


frads runs from the terminal prompt (command line) on Windows, Mac, and Linux OS. Radiance must be installed prior to use of frads. You can then install frads by entering the following command in your terminal/cmd/powershell:

pip install frads

You can also install frads from this Github repository using this command:

pip install git+

To do

  • 2-, 3-, 4-, and 5-phase methods implemented (image-based 5-phase works on Windows by aggressive sun-culling, 4-phase to be tested)
  • epJSON to Radiance workflow implemented (not fully tested), window puncher + wall thickener
  • EnergyPlus Radiance runtime interaction preliminarily implemented
  • Automated window subdivision analysis
  • Implement daylight metrics calculation with EnergyPlus integration
  • Implement thermal and visual comfort calculation with EnergyPlus integration
  • Link to global fenestration systems database and implement BSDF combination routines
  • Spawn of EnergyPlus integration, variable timestep detailed HVAC and control modeling


Wang, T., "Frads: A Python Library for Radiance Simulation Control", 2021 Radiance workshop, Bilbao, Spain, August 19, 2021, ppt , voice recording

Wang, T., Ward, G., and Lee, E.S. (2021), A Python Library for Radiance Matrix-based Simulation Control and EnergyPlus Integration, Proceedings of Building Simulation 2021, International Building Performance Simulation Association, Bruges, September 1-3, 2021. Publication to be posted: pdf

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 frads, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size frads-0.2.2.tar.gz (1.3 MB) File type Source Python version None Upload date Hashes View
Filename, size frads-0.2.2-py3-none-any.whl (1.4 MB) File type Wheel Python version py3 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 NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page