Skip to content

Core library

The xfea package is the core: the model, the problem, the results, and the plugins that ship with it for meshing, storing results and viewing.

  • Python 3.10 or newer.
  • A virtual environment, so xfea’s dependencies do not meet another project’s.
Terminal window
python -m venv .venv
source .venv/bin/activate
pip install "xfea[all]"

[all] adds Gmsh meshing, which runs as a program of its own (xfea-gmsh-worker), and the reader for the solver’s result files. Without it, pip install xfea installs the core alone: it builds models from nodes and elements you make yourself, but cannot mesh geometry or read a solve’s results.

From source, uv sync --all-packages installs every package of the repository in editable mode in one environment (.venv); it needs uv.

Part What it is
xfea The model, the problem, the results, and the contracts the plugins follow.
xfea_gmsh Meshing with Gmsh.
xfea_sqlite The results database, in SQLite.
xfea_view The browser viewer and the ParaView desktop launcher.
xfea_tools Cutting planes and cross-section plots, filtering and smoothing a mesh, selecting faces, fire curves.
xfea (command) The command line: xfea version, xfea settings, xfea status and the rest.

The core writes nothing solver-specific. To solve, it needs the conversion service and a solver on your machine: see Solvers.

  • Meshing with gmsh fails although xfea meshers lists it: the Gmsh worker is not installed. Install "xfea[all]".
  • xfea viewers lists nothing: reinstall xfea in this environment.
  • “No conversion service at https://app.xfea.ai” when solving: check your network, and see Solvers.

© 2026 Francesco Ranaudo · Text and pictures CC BY 4.0 · Code Elastic License 2.0 · how to reuse them