honeybee_vtk.time_step_images module

Function to generate images from time series data.

honeybee_vtk.time_step_images.export_time_step_images(hbjson_path: str, config_path: str, time_step: honeybee_vtk.config.TimeStepConfig, grid_display_mode: honeybee_vtk.vtkjs.schema.DisplayMode = <DisplayMode.Shaded: 2>, target_folder: str = '.', grid_filter: Union[str, List[str]] = None, full_match: bool = False, label_images: bool = True, image_width: int = 1920, image_height: int = 1088, image_scale=1) → str[source]

Export images of grids for each time step in the time stamps file.

This function will find all the time stamps between the start and end datetimes in the time stamps file and export images of each grids for each time step.

Parameters

  • hbjson_path – Path to the HBJSON file.

  • config_path – Path to the config file.

  • timestamp_file_name – Name of the time stamps file as a string. This is simply used to find the time stamps file.

  • periods – A list of tuple of start and end datetimes. Defaults to a single period from 8 am to 7 pm on 21st of June.

  • grid_display_mode – Display mode of the grids. Defaults to Shaded.

  • target_folder – Path to the folder to write the images. Defaults to the current folder.

  • grid_filter – A list of grid identifiers or a regex pattern as a string to filter the grids. Defaults to None.

  • full_match – A boolean to filter grids by their identifiers as full matches. Defaults to False.

  • text_actor – TextActor object to add to the images. Defaults to None.

  • label_images – Boolean to indicate whether to label images with the timestep or not. Defaults to True.

  • image_width – Width of the images. Defaults to 1920.

  • image_height – Height of the images. Defaults to 1088.

  • image_scale – An integer value as a scale factor. Defaults to 1.

Returns

A path to the target folder where all the images are written.

honeybee_vtk.time_step_images.write_time_step_data(time_step_file_path: str, periods_file_path: str, file_name: str = 'timestep_data', target_folder: str = '.') → pathlib.Path[source]

Create time step data to loop over.

This function reads the time step file and the periods file to generate JSON file that contains data required to generate image of each time step.

Parameters

  • time_step_file_path – Path to the time step file such as sun-up-hours.txt.

  • periods_file_path – Path to the periods file.

  • file_name – Name of the JSON file. Defaults to ‘timestep_data’.

  • target_folder – Path to the folder where the JSON file will be saved. Defaults to ‘.’.

Returns

A path to the timestep JSON file.