# VisFEM

> VisFEM: Web visualization of FEM models

The links below point to the markdown source of the documentation. [llms-full.txt](https://visfem.de/docs/llms-full.txt) contains all of it in a single file.

## Documentation

- [Home](https://visfem.de/docs/index.md): VisFEM is an interactive web app for visualizing Finite Element Method (FEM) simulation results, with a focus on biomedical applications.
- [Installation](https://visfem.de/docs/installation.md): VisFEM requires python >= 3.14 and is available from pypi.
- [Deployment](https://visfem.de/docs/deployment.md): Host VisFEM on a Linux server.
- [Contributing](https://visfem.de/docs/development.md): Contributions are welcome.

## User guide

- [Running the app](https://visfem.de/docs/usage.md): VisFEM runs as a local web server which the browser connects to; the `visfem` command starts it and prepares the datasets it shows.
- [Datasets](https://visfem.de/docs/datasets.md): A dataset is a folder of mesh files plus a JSON descriptor.
- [Renderers](https://visfem.de/docs/renderers.md): The `render` block of a descriptor selects one of the built-in renderers and configures it.
- [Example data](https://visfem.de/docs/example-data.md): Two public datasets are downloaded and laid out by the command line, so VisFEM can be tried without data of your own.

## API reference

- [Overview](https://visfem.de/docs/api/index.md): The API reference is generated from the docstrings of the package.
- [app](https://visfem.de/docs/api/app.md): Trame web application for FEM mesh visualization.
- [cli](https://visfem.de/docs/api/cli.md): Command-line interface for VisFEM.
- [models](https://visfem.de/docs/api/models.md): Pydantic models for mesh and project metadata validation.
- [mesh](https://visfem.de/docs/api/mesh.md): Mesh loading and metadata extraction for FEM simulation data.
- [febio](https://visfem.de/docs/api/febio.md): FEBio 2.x (.feb) geometry reader: <Nodes> and <Elements> into a PyVista UnstructuredGrid.
- [log](https://visfem.de/docs/api/log.md): Logging setup: one RichHandler on the visfem logger, level from VISFEM_LOG_LEVEL.
- [discovery](https://visfem.de/docs/api/engine/discovery.md): Dataset discovery and project metadata helpers.
- [renderers](https://visfem.de/docs/api/engine/renderers.md): Renderer registry and render-config resolution for a dataset's JSON ``render`` block (``visfem.models.RenderConfig``).
- [scene](https://visfem.de/docs/api/engine/scene.md): Scene management and mesh rendering helpers.
- [selection](https://visfem.de/docs/api/engine/selection.md): Dataset selection handlers that dispatch through the renderer registry.
- [playback](https://visfem.de/docs/api/engine/playback.md): Async background coroutines: vtk.js warmup and autoplay.
- [xr_manager](https://visfem.de/docs/api/engine/xr_manager.md): WebXR session management and in-VR exit panel.
- [colors](https://visfem.de/docs/api/engine/colors.md): Color utilities and background constants for VisFEM.
- [palettes](https://visfem.de/docs/api/engine/palettes.md): Color palette and colormap definitions for VisFEM.
- [layout](https://visfem.de/docs/api/ui/layout.md): Top-level UI assembly for VisFEM.
- [toolbar](https://visfem.de/docs/api/ui/toolbar.md): Toolbar UI for VisFEM.
- [left_panel](https://visfem.de/docs/api/ui/left_panel.md): Left panel with the dataset tree and the active dataset info.
- [right_panel](https://visfem.de/docs/api/ui/right_panel.md): Right panel: view, fibers, scalar field, color, regions, playback and scalar bar sections.
- [footer](https://visfem.de/docs/api/ui/footer.md): Footer UI for VisFEM.
- [widgets](https://visfem.de/docs/api/ui/widgets.md): Widgets shared by the panels: section headers and tooltip icon buttons.
- [theme](https://visfem.de/docs/api/ui/theme.md): Design tokens and CSS fragments for the VisFEM UI.

## Optional

- [Repository](https://github.com/matthiaskoenig/visfem): source code, issues and releases.
- [Sitemap](https://visfem.de/docs/sitemap.xml): all pages of the rendered site.
- [objects.inv](https://visfem.de/docs/objects.inv): the API objects of the reference as a sphinx inventory.