raytraverse-cli

raytraverse

raytraverse [OPTIONS] OUT COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

the raytraverse executable is a command line interface to the raytraverse python package for running and evaluating climate based daylight models. sub commands of raytraverse can be chained but should be invoked in the order given.

the easiest way to manage options and sure that Scene and SunSetter classes are properly reloaded is to use a configuration file, to make a template:

raytraverse --template > run.cfg

after adjusting the settings, than each command can be invoked in turn and any dependencies will be loaded with the correct options, a complete run and evaluation can then be called by:

raytraverse -c run.cfg OUT sky sunrun integrate

as both scene and sun will be invoked automatically as needed.

Arguments:

  • ctx: click.Context

  • out: path to new or existing directory for raytraverse run

  • config: path to config file

  • n: max number of processes to spawn

Arguments

OUT

Required argument

Options

VALUE OPTIONS:

-c, --config <PATH>

path of config file to load

-n <INTEGER>

sets the environment variable RAYTRAVERSE_PROC_CAP set to0 to clear (parallel processes will use cpu_limit)

FLAGS (DEFAULT FALSE):

--template, --no-template

write default options to std out as config

Default

False

HELP:

-opts, --opts

check parsed options

Default

False

--debug

show traceback on exceptions

Default

False

--version

Show the version and exit.

Default

False

Commands

suns

the suns command provides a number of options…

scene

The scene commands creates a Scene object…

suns

raytraverse suns [OPTIONS]

the suns command provides a number of options for creating sun positions used by sunrun see wea and usepositions options for details

Note:

the wea and skyro parameters are used to reduce the number of suns in cases where a specific site is known. Only suns within the solar transit (or positions if usepositions is True will be selected. It is important to note that when integrating, if a sun position outside this range is queried than results will not include the more detailed simulations involved in sunrun and will instead place the suns energy within the nearest sky patch. if skyres is small and or the patch is directly visible this will introduce significant bias in most metrics.

Options

VALUE OPTIONS:

-loc <FLOATS>

specify the scene location (if not specified in -wea or to override. give as “lat lon mer” where lat is + North, lon is + West and mer is the timezone meridian (full hours are 15 degree increments)

-skyro <FLOAT>

counter clockwise rotation (in degrees) of the sky to rotate true North to project North, so if project North is 10 degrees East of North, skyro=10

Default

0.0

-sunres <FLOAT>

resolution in degrees of the sky patch grid in which to stratify sun samples. Suns are randomly located within the grid, so this corresponds to the average distance between sources. The average error to a randomly selected sun position will be on average ~0.4 times this value

Default

10.0

-wea <TEXT>

path to weather/sun position file. possible formats are:

  1. .wea file

  2. .wea file without header (require -loc and –no-usepositions)

  3. .epw file

  4. .epw file without header (require -loc and –no-usepositions)

  5. 3 column tsv file, each row is dx, dy, dz of candidate sun position (requires –usepositions)

  6. 4 column tsv file, each row is altitude, azimuth, direct normal, diff. horizontal of canditate suns (requires –usepositions)

  7. 5 column tsv file, each row is dx, dy, dz, direct normal, diff. horizontal of canditate suns (requires –usepositions)

tsv files are loaded with loadtxt

FLAGS (DEFAULT TRUE):

--reload, --no-reload

if False, regenerates sun positions, because positions may be randomly selected this will make any sunrun results obsolete

Default

True

FLAGS (DEFAULT FALSE):

--plotdview, --no-plotdview

creates a png showing sun positions on an angular fisheye projection of the sky. sky patches are colored by the maximum contributing ray to the scene

Default

False

--printsuns, --no-printsuns

print sun positions to stdout

Default

False

--usepositions, --no-usepositions

if True, sun positions will be chosen from the positions listed in wea. if more than one position is a candidate for that particular sky patch (as determined by sunres) than a random choice will be made. by using one of the tsv format options for wea, and preselecting sun positions such that there is 1 per patch a deterministic result canbe achieved.

Default

False

HELP:

-opts, --opts

check parsed options

Default

False

--debug

show traceback on exceptions

Default

False

--version

Show the version and exit.

Default

False

scene

raytraverse scene [OPTIONS]

The scene commands creates a Scene object which holds geometric information about the model including object geometry (and defined materials), the analysis plane and the desired resolutions for sky and analysis plane subdivision

Options

VALUE OPTIONS:

-scene <TEXT>

space separated list of radiance scene files (no sky) or precompiled octree

FLAGS (DEFAULT TRUE):

--frozen, --no-frozen

create frozen octree from scene files

Default

True

--log, --no-log

log progress to <out>/log.txt

Default

True

--reload, --no-reload

if a scene already exists at OUT reload it, note that ifthis is False and overwrite is False, the program willabort

Default

True

FLAGS (DEFAULT FALSE):

--overwrite, --no-overwrite

Warning! if set to True and reload is False all files inOUT will be deleted

Default

False

HELP:

-opts, --opts

check parsed options

Default

False

--debug

show traceback on exceptions

Default

False

--version

Show the version and exit.

Default

False