export¶
honeybee-vtk export¶
Command to export media from a honeybee-vtk model.
honeybee-vtk export [OPTIONS] COMMAND [ARGS]...
grid-images¶
Export images of the grids for the Honeybee Model created from the HBJSON file.
honeybee-vtk export grid-images [OPTIONS] HBJSON_FILE
Options
-
-f,--folder<folder>¶ Path to target folder.
- Default
.
-
-it,--image-type<image_type>¶ choose the type of image file.
- Default
jpg
- Options
png | jpg | ps | tiff | bmp | pnm
-
-iw,--image-width<image_width>¶ Width of images in pixels. Defaults to 1920 pixels.
- Default
1920
-
-ih,--image-height<image_height>¶ Height of images in pixels. Defaults to 1088 pixels.
- Default
1080
-
-is,--image-scale<image_scale>¶ Scale of the image. Default is set to 1.
- Default
1
-
-bc,--background-color<background_color>¶ Set background color for images
- Default
255, 255, 255
-
-go,--grid-options<grid_options>¶ Export sensor grids as either points or meshes.
- Default
ignore
- Options
ignore | points | meshes
-
-gdm,--grid-display-mode<grid_display_mode>¶ Set display mode for the Sensorgrids.
- Default
shaded
- Options
shaded | surface | surfacewithedges | wireframe | points
-
-cf,--config<config>¶ File Path to the config json file which can be used to mount simulation data on HBJSON.
-
-gf,--grid-filter<grid_filter>¶ A regex pattern as a string to filter the grids. Defaults to * which will export all the grids.
- Default
-
--full-match,--no-full-match¶ Flag to note whether the grids should be filtered by their identifiers as full matches.
- Default
False
-
--text-content<text_content>¶ Text to be displayed on an image of a grid. This will put this same text on all of the images.
-
-th,--text-height<text_height>¶ Set the height of the text in pixels for the text that will be added to the image of a grid.
- Default
15
-
-tc,--text-color<text_color>¶ Set the text color of the text that will added to the image of a grid.
- Default
0, 0, 0
-
-tp,--text-position<text_position>¶ Set the text position of the text to added to the image of a grid. The setting is applied at the lower left point of the text. (0,0) will give you the lower left corner of the image. (1,1) will give you the upper right corner of the image.
- Default
0.5, 0.0
-
--text-bold,--text-normal¶ Set the text to be bold for the text that will added to the image of a grid.
- Default
False
Arguments
-
HBJSON_FILE¶ Required argument
model-images¶
Export images of the Honeybee Model created from the HBJSON file.
honeybee-vtk export model-images [OPTIONS] HBJSON_FILE
Options
-
-f,--folder<folder>¶ Path to target folder.
- Default
.
-
-it,--image-type<image_type>¶ choose the type of image file.
- Default
jpg
- Options
png | jpg | ps | tiff | bmp | pnm
-
-iw,--image-width<image_width>¶ Width of images in pixels. If not set, Radiance default x dimension of view will be used.
- Default
0
-
-ih,--image-height<image_height>¶ Height of images in pixels.If not set, Radiance default y dimension of view will be used.
- Default
0
-
-bc,--background-color<background_color>¶ Set background color for images
- Default
255, 255, 255
-
-mdm,--model-display-mode<model_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 | radial-grid
-
-gdm,--grid-display-mode<grid_display_mode>¶ Set display mode for the Sensorgrids.
- Default
shaded
- Options
shaded | surface | surfacewithedges | wireframe | points
-
-ta,--triangle-angle<triangle_angle>¶ Set the internal angle of thetriangles in the grid in case radial-grid is selected from grid options
- Default
45
-
-tr,--triangle-radius<triangle_radius>¶ Set the radial height ofthe triangles in the grid in case radial-grid is selected from grid options
-
-vf,--view<view>¶ File Path to the Radiance view file. Multiple view files are accepted.
-
-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
time-step-images¶
Export images of the grids for the Honeybee Model created from the HBJSON file.
honeybee-vtk export time-step-images [OPTIONS] HBJSON_FILE
Options
-
-cf,--config<config>¶ Required File Path to the config json file which can be used to mount simulation data on HBJSON.
-
-tsf,--time-step-file<time_step_file>¶ Required File Path to the time step JSON file that has the data needed to export images of each time step.
-
-f,--folder<folder>¶ Path to target folder.
- Default
.
-
-gf,--grid-filter<grid_filter>¶ A regex pattern as a string to filter the grids. Defaults to * which will export all the grids.
- Default
-
--full-match,--no-full-match¶ Flag to note whether the grids should be filtered by their identifiers as full matches.
- Default
False
-
-li,--label,--no-label¶ Flag to indicate whether to label images or not. A label is a timestep information that is added to the bottom center of the image. If the exported images are going to be post-processed, it is advised to not label the images.
- Default
False
-
-iw,--image-width<image_width>¶ Width of images in pixels. If not set, Radiance default x dimension of view will be used.
- Default
1920
-
-ih,--image-height<image_height>¶ Height of images in pixels.If not set, Radiance default y dimension of view will be used.
- Default
1088
-
-is,--image-scale<image_scale>¶ Scale of the image. Default is set to 1.
- Default
1
Arguments
-
HBJSON_FILE¶ Required argument