Skip to main content

veux

SEES Logo

Highly efficient and portable finite element visualization framework


DOI Latest PyPI version

veux is a finite element rendering library that leverages modern web technologies to produce sharable, efficient, and detailed renderings.



veux is a finite element rendering library that leverages modern web technologies to produce sharable, efficient, and detailed renderings. Unlike most tools that only provide temporary visualization, veux generates persistent 3D models that can be stored in files, shared with colleagues, and viewed with any standard 3D model viewer. This means anyone can interact with the renderings without needing to install specialized software or even Python. Simply open the 3D object with your computer’s 3D viewer (e.g., 3D Viewer on Windows) or load it into a free online viewer in like gltf-viewer.

Documentation is currently under development.

Features

  • Detailed Render frames with extruded cross sections
  • Persistence: Save your finite element visualizations as persistent 3D models that can be revisited and analyzed at any time.
  • Portability: Share your models effortlessly with colleagues, enabling seamless collaboration and review.
  • Accessibility: View and interact with the models using any standard 3D model viewer, eliminating the need for specialized software or Python installation.
  • Versatility: A wide selection of rendering backends and output file types, including optimized 3D web formats like .glb. Generated 3D models can be loaded directly into programs like PowerPoint and animated.
  • Correctly render models that treat both y or z as the vertical coordinate.

Gallery

Getting Started

To install veux run:

pip install veux

Command Line Interface

To create a rendering, execute the following command from the anaconda prompt (after activating the appropriate environment):

python -m veux model.json -o model.html

where model.json is a JSON file generated from executing the following OpenSees command:

print -JSON model.json

If you omit the -o <file.html> portion, it will plot immediately in a new window. You can also use a .png extension to save a static image file, as opposed to the interactive html.

Note Printing depends on the JSON output of a model. Several materials and elements in the OpenSeesPy and upstream OpenSees implementations do not correctly print to JSON. For the most reliable results, use the opensees package.

By default, the rendering treats the $y$ coordinate as vertical. In order to manually control this behavior, pass the option --vert 3 to render model $z$ vertically, or --vert 2 to render model $y$ vertically.

If the opensees package is installed, you can directly render a Tcl script without first printing to JSON, by just passing a Tcl script instead of the JSON file:

python -m veux model.tcl -o model.html

To plot an elevation (elev) plan (plan) or section (sect) view, run:

python -m veux model.json --view elev

and add -o <file.extension> as appropriate.

To see the help page run

python -m veux --help

Related Links

See also

The veux packages was used to generate figures for the following publications:

Support

PEER Logo Caltrans Logo STAIRlab Logo

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

veux-0.0.1.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

veux-0.0.1-cp313-cp313-macosx_14_0_arm64.whl (7.0 MB view details)

Uploaded CPython 3.13macOS 14.0+ ARM64

File details

Details for the file veux-0.0.1.tar.gz.

File metadata

  • Download URL: veux-0.0.1.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for veux-0.0.1.tar.gz
Algorithm Hash digest
SHA256 292da989427e6ab452a4dc55d4b511cb25e457414e63d3f474919ca512eff28c
MD5 4f4cd890fa29218b039e4e5e075fe9ad
BLAKE2b-256 54da9be9b43701936203cf61521920e057592d4a0dc63c80fda4423ba2287070

See more details on using hashes here.

File details

Details for the file veux-0.0.1-cp313-cp313-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for veux-0.0.1-cp313-cp313-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 cbd56ae628d87fca1218d42511caa44eafe472895e72a9e87225896f7cf12f9b
MD5 1efe51f0ee1b27e420c7ff9fe2d1d823
BLAKE2b-256 61742d78055ed128255240cfcc35168bbb48cbe349154a5d30ba2363ac287140

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page