WorkflowConfig
frads.WorkflowConfig
dataclass
Workflow configuration dataclass.
Workflow configuration is initialized with the Settings and Model dataclasses. A hash string is generated from the config content.
Attributes:
Name | Type | Description |
---|---|---|
settings |
Settings
|
A Settings object. |
model |
Model
|
A Model object. |
hash_str |
str
|
A hash string of the config content. |
frads.methods.Settings
dataclass
Settings is a dataclass that holds the settings for a Radiance simulation.
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
The name of the simulation. |
num_processors |
int
|
The number of processors to use for the simulation. |
method |
str
|
The Radiance method to use for the simulation. |
overwrite |
bool
|
Whether to overwrite existing files. |
save_matrices |
bool
|
Whether to save the matrices generated by the simulation. |
sky_basis |
str
|
The sky basis to use for the simulation. |
window_basis |
str
|
The window basis to use for the simulation. |
non_coplanar_basis |
str
|
The non-coplanar basis to use for the simulation. |
sun_basis |
str
|
The sun basis to use for the simulation. |
sun_culling |
bool
|
Whether to cull suns. |
separate_direct |
bool
|
Whether to separate direct and indirect contributions. |
epw_file |
str
|
The path to the EPW file to use for the simulation. |
wea_file |
str
|
The path to the WEA file to use for the simulation. |
start_hour |
float
|
The start hour for the simulation. |
end_hour |
float
|
The end hour for the simulation. |
daylight_hours_only |
bool
|
Whether to simulate only daylight hours. |
latitude |
float
|
The latitude for the simulation. |
longitude |
float
|
The longitude for the simulation. |
timezone |
float
|
The timezone for the simulation. |
orientation |
float
|
sky rotation. |
site_elevation |
float
|
The elevation for the simulation. |
sensor_sky_matrix |
List[str]
|
The sky matrix sampling parameters |
view_sky_matrix |
List[str]
|
View sky matrix sampling parameters |
sensor_sun_matrix |
List[str]
|
Sensor sun matrix sampling parameters |
view_sun_matrix |
List[str]
|
View sun matrix sampling parameters |
sensor_window_matrix |
List[str]
|
Sensor window matrix sampling parameters |
view_window_matrix |
List[str]
|
View window matrix sampling parameters |
daylight_matrix |
List[str]
|
Daylight matrix sampling parameters |
frads.methods.Model
dataclass
Model dataclass.
Attributes:
Name | Type | Description |
---|---|---|
scene |
SceneConfig
|
SceneConfig object |
windows |
Dict[str, WindowConfig]
|
A dictionary of WindowConfig |
materials |
MaterialConfig
|
MaterialConfig object |
sensors |
Dict[str, SensorConfig]
|
A dictionary of SensorConfig |
views |
Dict[str, ViewConfig]
|
A dictionary of ViewConfig |