Skip to content

API reference

The API reference is generated from the docstrings of the package. VisFEM is an application: the reference documents its internals for development, not a stable library interface.

Application

module description
app the trame application, its state and the callbacks of the UI
cli the visfem command line
models the pydantic models of the dataset descriptors and the mesh metadata
mesh loading of meshes and time series, metadata extraction and caching
febio reader of the geometry of FEBio 2.x models
log logging of the app

visfem.engine

module description
discovery discovery of the datasets of the data directory
renderers the renderer registry and the resolution of the render block
scene the plotter, its actors and the scalar bar
selection handlers of the dataset selection
playback autoplay of time series and the vtk.js warmup
xr_manager WebXR sessions
colors colour utilities and the background colours
palettes categorical palettes and continuous colormaps

visfem.ui

module description
layout assembly of the page
toolbar the toolbar
left_panel dataset tree and dataset info
right_panel view, colour, regions, fields and playback
footer the footer
widgets widgets shared by the panels
theme design tokens and CSS fragments