Honeybee extension for translating HBJSON to VTK
Project description
honeybee-vtk
🐝 VTK - Honeybee extension for viewing HBJSON in a web browser.
Installation
pip install honeybee-vtk
QuickStart
import honeybee_vtk
Usage
Usage: honeybee-vtk translate [OPTIONS] HBJSON_FILE
Translate a HBJSON file to several VTK, XML, or HTML file.
The output file is either a zipped file that contains all the generated
VTK/XML files or an HTML file.
Args:
hbjson-file: Path to input HBJSON file.
Options:
-n, --name TEXT Name of the output file. If not provided,
the name of input HBJSON file will be used.
-f, --folder DIRECTORY Path to target folder. [default: .]
-t, --file-type [vtk|xml|html] Switch between VTK, XML, and HTML formats.
Default is HTML. [default: html]
-ig, --include-grids Export grids. [default: False]
-is, --include-sensors [vectors|points]
Export sensors as either arrows or color-
grouped points.
-in, --include-normals [vectors|points]
Export aperture normals as either arrows or
color-grouped points.
-sh, --show-html, --show Open the generated HTML file in a browser.
[default: False]
--help Show this message and exit.
Viewing an HBJSON generated from a model that ships with Ladybug Tools. You can send this HTML to someone and they will be able to open the see the same model.
honeybee-vtk translate "path to hbjson file" --include-grids --include-sensors="vectors" --show
Exporting points colored based on the direction of the normals for apertures and grid sensors. This is useful for models with very high number of sensors or apertures.
honeybee-vtk translate "path to hbjson file" --include-grids --include-sensors="points" --include-normals="points" --show
Saving the files in VTK format and then viewing in Paraview Glance. This is useful if you prefer smaller file sizes. Use "xml" in file-type to export XML files. If you wish to share a model that you have formatted in Paraview Glance, click on "Save State" button in the navbar of Paraview Glance. This will download a .glance file that you can share with others and they will be able to load this file back in Paraview Glance and see the model the way you formatted it.
honeybee-vtk translate "path to hbjson file" --folder="path to the target folder" --file-type="vtk"
API Documentation
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file honeybee-vtk-0.7.10.tar.gz.
File metadata
- Download URL: honeybee-vtk-0.7.10.tar.gz
- Upload date:
- Size: 28.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65527e3077f036e59db74eb8d1a96f751449652b04ba9849002088b8fbcc1271
|
|
| MD5 |
83dd3238794dab3f729b1a51a4917f7e
|
|
| BLAKE2b-256 |
2028a3ace737dfa698015a7b5efd9c2a2c2311edd600347cbc2d322839f61930
|
File details
Details for the file honeybee_vtk-0.7.10-py2.py3-none-any.whl.
File metadata
- Download URL: honeybee_vtk-0.7.10-py2.py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3171d4b23d58872febaa42b35b43599e99bccc6323b1caf920fdbf54ddd942c0
|
|
| MD5 |
239501f0387ad9852e188fbd77d9d58a
|
|
| BLAKE2b-256 |
966513b3ac0cd3ab8c452c545b9dff2b4b0fcc720a1a9ae72fc5086cd581f9ee
|
