There are no reviews yet. Be the first to send feedback to the community and the maintainers!
RCSid "$Id: README.txt,v 1.7 2020/09/03 15:46:32 greg Exp $" Hello and welcome to the Radiance synthetic imaging system. This is the twenty-fifth release, Version 5.4, and it includes all source files for local compilation with a standard C compiler. To find out what's new in this release, check the text file "doc/notes/ReleaseNotes". Radiance is OpenSource software copyrighted and distributed by Lawrence Berkeley National Laboratory in California. By downloading and installing this software, you are implicitly agreeing to the OpenSource license appended to this README file. Please read it carefully before proceeding -- this is very different from previous licenses, and contains fewer restrictions on commercialization. Please read this entire file before sending e-mail asking how to install this software or what to do with it. Some frequently asked questions are answered here and also on our website at: http://radsite.lbl.gov/radiance/ The CVS source tree is available, including post-release bug-fixes and mailing lists access at: http://www.radiance-online.org/ The websites above should also have some precompiled Radiance binaries and add-ons for common Unix platforms. We have attempted to make it easy for you (and for us) to install the software on differently configured systems using a global make script. To install the software, just type: ./makeall install You can clean up the .o files and so forth with: ./makeall clean Or, if you are confident you can do both at the same time with: ./makeall install clean You can give other make options at the end of the command as well. For example, the -n option will tell you what makeall is going to do without actually doing it. If you downloaded the binaries, so compilation is not necessary, run the following command to install the library files only: ./makeall library The makeall may script ask you questions about your system and where you want to install the executables and library files. The pathnames you give should be relative to root for the programs to work properly. You may also use the tilde ('~') character to give paths starting with someone's home directory. If you do NOT have X11 support, please read the note "noX11.help" in this directory. It explains what to change to make things work. Although it is set automatically by makeall, individuals may want to set the RAYPATH environment variable manually. This variable tells Radiance where to look for auxiliary files, and usually includes the current directory as well as the system library (ray/lib in this distribution). As you develop auxiliary files yourself, it is often useful to add in your own library directory before the system directory. An example setting such as this would go in a user's .login file: setenv RAYPATH .:${HOME}/mylib:/usr/local/lib/ray After installing the software, you may want to start by scanning the troff input documentation contained in "doc/ray.1", which is also formatted for web browsers in "doc/ray.html". A PDF version of this manual may be found in "doc/pdf/ray.pdf", along with an older tutorial by Cindy Larson, "doc/pdf/raduser1_6.pdf". For complete documentation on the system as of release 3.1, refer to "Rendering with Radiance" by Larson and Shakespeare, which used to be available from Morgan Kauffman Publishing. Recently, the authors have taken over printing of the book, which is now available from booksurge.com. You may find it linked to the Radiance website page: http://radsite.lbl.gov/radiance/book/ The first chapter of this book, which includes a basic tutorial and serves as a good introduction for new users, may be found in "doc/pdf/RwR01.pdf". Important additions since version 3.1 include the holodeck programs (rholo, etc., built in src/hd), glrad, ranimove, the new "mesh" primitive, and rtcontrib. Again, check doc/notes/ReleaseNotes for details. Individual manual pages may be found in the subdirectory "doc/man". You may want to copy these to the system manual directory, or add this directory to your MANPATH environment variable in your shell initialization file. A good starting place is to print the text file ray/doc/man/whatis, which gives a one line description of each program in the Radiance package. To print out the manual pages, use the "-man" macro package. The most important program to learn about if you are a new user of Radiance (or have not used this program before) is "rad". It controls Radiance lighting parameters, and automates much of the rendering process. To get started, change directory to obj/misc and try running: % rad -o x11 daf.rif This works if you are running X11. If you are not, you can still generate an image with: % rad daf.rif & When the picture is done, you can convert it to another format for display with any of the ra_* programs listed in the doc/whatis database. There is a user interface built on top of this using Tcl/Tk, called trad. If you do not have Tcl/Tk installed on your system, you must do so prior to building this distribution if you want trad to install. (Try a google search on "Tcl/Tk" or go to "http://www.scriptics.com/software/tcltk/".)
api-umbrella
Open source API management platformEnergyPlus
EnergyPlusâ„¢ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.OpenStudio
OpenStudio is a cross-platform collection of software tools to support whole building energy modeling using EnergyPlus and advanced daylight analysis using Radiance.SAM
System Advisor Model (SAM)floris
A controls-oriented engineering wake model.OpenOA
This library provides a framework for assessing wind plant performance using operational assessment (OA) methodologies that consume time series data from wind plants. The goal of the project is to provide an open source implementation of common data structures, analysis methods, and utility functions relevant to wind plant OA.rdtools
PV Analysis Tools in Pythonvagrant-boxes
SOWFA
ReEDS-2.0
pysam
Python Wrapper for the System Advisor ModelHPC
A collection of various resources, examples, and executables for the general NREL HPC user community's benefit. Use the following website for accessing documentation.resstock
Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.ROSCO
A Reference Open Source Controller for Wind TurbinesPowerGridworld
PowerGridworld provides users with a lightweight, modular, and customizable framework for creating power-systems-focused, multi-agent Gym environments that readily integrate with existing training frameworks for reinforcement learning (RL). https://arxiv.org/abs/2111.05969reV
Renewable Energy Potential (reV) Modelhsds-examples
Examples of using the HSDS Service to Access NREL WIND Toolkit dataREopt_API
The model for the REopt API, which is used as the back-end for the REopt Webtool (reopt.nrel.gov/tool), and can be accessed directly via the NREL Developer Network (https://developer.nrel.gov/docs/energy-optimization/reopt)bifacial_radiance
Toolkit for working with RADIANCE for the ray-trace modeling of Bifacial Photovoltaicsopenstudio-standards
sup3r
The Super-Resolution for Renewable Resource Data (sup3r) software uses generative adversarial networks to create synthetic high-resolution wind and solar spatiotemporal data from coarse low-resolution inputs.ssc
SAM Simulation Core (SSC) contains the underlying performance and financial models for SAMphygnn
physics-guided neural networks (phygnn)ditto
DiTTo is a Distribution Transformation Tool that aims at providing an open source framework to convert various distribution systems modeling formats.floorspace.js
mappymatch
Pure-python package for map matchingEvoProtGrad
Directed evolution of proteins in sequence space with gradientsPhIRE
dgen
The Distributed Generation Market Demand (dGen) model simulates customer adoption of distributed energy resources (DERs) for residential, commercial, and industrial entities in the United States and other countries.BuildingsBench
Large-scale pretraining and benchmarking for short-term load forecasting.wex
WEX, which is short for WxWidgets Extensions, is a cross-platform library of graphical user interface tools that extends the popular open-source project WxWidgets. WEX includes many features including the powerful DView program (https://github.com/NREL/wex/wiki/DView), which provides an easy-to-use way to visualize complex time series data.turbine-models
Documentation for the turbine models in this repository is available below.nfp
Keras layers for end-to-end learning with rdkit and pymatgenalfabet
Machine learning predictions of bond dissociation energyWindSE
ParaEMT_public
BuildingMOTIF
Building Metadata OnTology Interoperability Framework (BuildingMOTIF). For models, see https://models.open223.info/SolarPILOT
SolarPILOT power tower layout and optimization tooldynamo
A modular MATLAB toolkit for Dynamic programming (DP) and Approximate Dynamic Programming (ADP) for Adaptive Modeling and OptimizationOpenStudio-server
The OpenStudio Server is a docker or Helm deployable instance which allows for large-scale parametric analyses of building energy models using the OpenStudio or URBANopt CLIs.PRAS
NREL's Probabilistic Resource Adequacy Suite (PRAS)developer.nrel.gov
An issue tracker for NREL's APIs available at https://developer.nrel.govgdx-pandas
Python interface to read and write GAMS GDX files using pandas.DataFrames as the intermediate data format.alfalfa
Alfalfa is a web service that enables runtime interaction with building energy models (OpenStudio/EnergyPlus and FMUs compiled from Modelica or Spawn) over REST APIs.OpenStudio-HPXML
Modeling of residential buildings in EnergyPlus using OpenStudio/HPXML.OCHRE
A Python-based building energy modeling (BEM) tool designed to model flexible loads in residential buildingsgraph-env
Reinforcement learning for combinatorial optimization over directed graphselm
ELM is a collection of utilities to apply Large Language Models (LLMs) to energy research.OPFLearn.jl
A Julia package that efficiently creates representative datasets for machine learning approaches to AC optimal power flowPyPSCAD
PV_ICE
An open-source tool to quantify Solar Photovoltaics (PV) Energy and Mass Flows in the Circular Economy, from a Reliability and Lifetime approachwindtools
Python tools for wind simulation setup, data processing, and analysisPyDSS
SolTrace
SolTraceMATBOX_Microstructure_analysis_toolbox
MATBOX is an open-source MATLAB toolbox dedicated to microstructure analsyis of porous/heterogeneous materialsREopt-Analysis-Scripts
OpenStudio-analysis-spreadsheet
The OpenStudio Analysis Spreadsheet is a front-end for the OpenStudio Server, allowing for users to create large-scale cloud analyses using OpenStudio measures.flasc
A rich floris-driven suite for SCADA analysisSOWFA-6
lk
LK (Language Kit) is a simple but powerful scripting language that is designed to be small, fast, and easily embedded in other applications. The core LK engine, including lexical analyzer, parser, compiler, and virtual machine is only dependent on the Standard C++ Library (STL), making it extremely lightweight and portable.rlmolecule
A reinforcement learning library for material and molecule optimizationGEOPHIRES-v2
GEOPHIRES v2.0: a free and open-source geothermal techno-economic simulatorbifacialvf
Bifacial PV View Factor model for system performance calculationopenfast-turbine-models
A repository of OpenFAST turbine models developed by NREL researchers.ATB-calc
Python files and Jupyter notebooks for processing the Annual Technology Baseline (ATB) electricity data and determining LCOE and other metrics.MoorPy
EnergyPlusRelease
ComStock
National scale modeling of the U.S. commercial building stock supported by U.S. DOE, LADWP, and others and maintained by NRELPVDegradationTools
Set of tools to calculate degradation responses and degradation related parameters for PV.OpenStudio-PAT
The Parametric Analysis Tool (PAT) is part of the OpenStudio collection of software tools.m2p
DSS-SimPy-RL
This repository is an Reinforcement Learning Platform for learning agents to control cyber-physical Power Distribution Systems resiliently. The cyber environment in based on SimPy Discrete Event Simulator, while the distribution system is backened by Open-DSS.BACnet
REopt.jl
api-umbrella-gatekeeper
See the https://github.com/NREL/api-umbrella repository instead.HOPP
api-umbrella-web
See the https://github.com/NREL/api-umbrella repository instead.OpenWARP
Please visit http://nrel.github.io/OpenWARP/ for more information.ROSCO_toolbox
A repository for generating ROSCO controller input files and more.hive
HIVEâ„¢ is a mobility services research platformbuildstockbatch
PyPSSE
Panel-Segmentation
This open-source package provides a framework for automatically detecting and extracting metadata from solar array installations in satellite images.reVX
The Renewable Energy Potential(V) eXchange Tool: reVXOpenStudio-Prototype-Buildings
HydroChrono
A hydrodynamics extension for Project Chrono, enabling simulations of wave energy converters, floating offshore wind turbines, and more.docker-openstudio
Repository for managing the builds of OpenStudio Docker images.fastsim
electrolyzer
ProgressiveHedging.jl
Basic progressive hedging implementation in Juliarex
REsource eXtraction Tool (rex)powerscenarios
Realistic renewable energy scenarios for stochastic grid optimization problemshescore-hpxml
HPXML to Home Energy Score TranslatorOpenStudio-fault-measure-gem
OpenStudio measures for modeling building faultsCampusEnergyModeling
latex_editing
OpenStudio-resources
OpenStudio-ERI
Energy Rating Index (ERI) calculation via OpenStudio/EnergyPlus.NRWAL
The National Renewable Energy Laboratory Wind Analysis Libray (NRWAL)altrios
Love Open Source and this site? Check out how you can help us