Skip to main content

adaptive sampling for CBDM

Project description

raytraverse (1.2.1)

PyPI PyPI - License Read the Docs (version) Travis (.org) Travis (.com) Coveralls github https://zenodo.org/badge/doi/10.5281/zenodo.4091318.svg

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.

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.

Getting Started

the following example script shows the basic workflow for a complete simulation it can be saved to a local file with:

raytraverse examplescript > example.py

or the file is located at raytraverse/example.py

History

1.0.4 (2020-11-18)

  • create and manage log file (attribute of Scene) for run directories

  • possible fix for bug in interpolate_kd resulting in index range errors

  • protect imports in cli.py so documentation can be built without installing

1.0.3 (2020-11-10)

  • new module for calculating position based on retinal features

  • view specifications for directview plotting

  • options for samples/weight visibility on directview plotting

0.2.0 (2020-09-25)

  • Build now includes all radiance dependencies to setup multi-platform testing

  • In the absence of craytraverse, sampler falls back to SPRenderer

  • install process streamlined for developer mode

  • travis ci deploys linux and mac wheels directly to pypi

  • release.sh should be run after updating this file, tests past locally and

    docs build.

0.1.0 (2020-05-19)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

raytraverse-1.2.1.tar.gz (6.8 MB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page