raytraverse (1.0.4)

raytraverse is a complete workflow for climate based daylight modelling, simulation, and evaluation of architectural spaces. Built around a wavelet guided adaptive sampling strategy, raytraverse can fully explore the daylight conditions throughout a space with efficient use of processing power and storage space.

• Free software: Mozilla Public License 2.0 (MPL 2.0)

• Documentation: https://raytraverse.readthedocs.io/en/stable/.

Installation

The easiest way to install raytraverse is with pip:

pip install --upgrade pip setuptools wheel
pip install raytraverse

or if you have cloned this repository:

cd path/to/this/file
pip install .

note that on first run the skycalc module may download some auxilary data which could take a minute, after that first run start-up is much faster.

Usage

raytraverse includes a complete command line interface with all commands nested under the raytraverse parent command enter:

raytraverse --help

raytraverse also exposes an object oriented API written primarily in python. calls to Radiance are made through Renderer objects that wrap the radiance c source code in c++ classes, which are made available in python with pybind11. see the src/ directory for more.

For complete documentation of the API and the command line interface either use the Documentation link included above or:

pip install -r docs/requirements.txt
make docs

to generate local documentation.

Command Line Interface

• raytraverse
  • scene
  • sky
  • suns
  • sunrun
  • onesky
  • integrate

API

• raytraverse.scene
  • Scene
  • SunSetterBase
  • SunSetter
  • SunSetterLoc
  • SunSetterPositions
  • SkyInfo
• raytraverse.mapper
  • SpaceMapper
  • SpaceMapperPt
  • ViewMapper
• raytraverse.renderer
  • Renderer
  • RadianceRenderer
  • Rtrace
  • Rcontrib
  • SPRenderer
  • SPRtrace
  • SPRcontrib
• raytraverse.sampler
  • Sampler
  • SCBinSampler
  • SunSampler
  • SingleSunSampler
  • SunViewSampler
  • SkySampler
• raytraverse.lightfield
  • LightField
  • LightFieldKD
  • SCBinField
  • SunField
  • SunSkyPt
  • SunViewField
  • StaticField
  • MemArrayDict
• raytraverse.integrator
  • BaseIntegrator
  • Integrator
  • SunSkyIntegrator
  • MetricSet
  • PositionIndex
  • retina
• raytraverse.craytraverse
• raytraverse.draw
• raytraverse.io
• raytraverse.plot
• raytraverse.quickplot
• raytraverse.skycalc
• raytraverse.translate

Licence

Copyright (c) 2020 Stephen Wasilewski, HSLU and EPFL

This Source Code Form is subject to the terms of the Mozilla Public

License, v. 2.0. If a copy of the MPL was not distributed with this

file, You can obtain one at http://mozilla.org/MPL/2.0/.

Acknowledgements

Thanks to additional project collaborators and advisors Marilyne Andersen, Lars Grobe, Roland Schregle, Jan Wienold, and Stephen Wittkopf

This software development was financially supported by the Swiss National Science Foundation as part of the ongoing research project “Light fields in climate-based daylight modeling for spatio-temporal glare assessment” (SNSF #179067).

Software Credits

• Raytraverse uses Radiance

• As well as all packages listed in the requirements.txt file, raytraverse relies heavily on the Python packages numpy, scipy, and pywavelets for key parts of the implementation.

• C++ bindings, including exposing core radiance functions as methods to the renderer classes are made with pybind11

• Installation and building from source uses cmake and scikit-build

• This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.