translate

honeybee-vtk translate

Translate a HBJSON file to an HTML or a vtkjs file.

Args:
hbjson-file: Path to an HBJSON file.
honeybee-vtk translate [OPTIONS] HBJSON_FILE

Options

-n, --name <name>

Name of the output file.

Default

model

-f, --folder <folder>

Path to target folder.

Default

.

-ft, --file-type <file_type>

Switch between html and vtkjs formats

Default

html

Options

html | vtkjs | vtp | vtk

-dm, --display-mode <display_mode>

Set display mode for the model.

Default

shaded

Options

shaded | surface | surfacewithedges | wireframe | points

-go, --grid-options <grid_options>

Export sensor grids as either points or meshes.

Default

ignore

Options

ignore | points | meshes

-sh, --show-html, --show

Open the generated HTML file in a browser.

Default

False

-cf, --config <config>

File Path to the config json file which can be used to mount simulation data on HBJSON.

-vd, --validate-data

Validate simulation data before loading on the model. This is recommended when using this command locally.

Default

False

Arguments

HBJSON_FILE

Required argument