Skip to content

Installation overview

xfea needs three things: the Python packages, an account for the conversion service (to solve), and a solver on your machine.

Install one of the two:

Terminal window
pip install xfea-mcp # the MCP server for your AI assistant, with xfea and Gmsh meshing
Terminal window
pip install "xfea[all]" # xfea alone, to script models in Python

Python 3.10 or newer. See Core library for a virtual environment and for installing from source.

2. An account and a solver plugin, to solve

Section titled “2. An account and a solver plugin, to solve”

Turning a model into the solver’s input is done by that solver’s plugin, on xfea’s service: sign up on app.xfea.ai, subscribe to the plugin for your solver, and take your API key from your account page (free during early access). Keep it in ~/.xfea/api_key: Solvers shows how. Without an account you can still build, mesh, check and show models: see What’s free, what needs an account.

The solver runs on your machine: install the one whose plugin you subscribed to, with its executable on your PATH.

xfea-mcp is an MCP server that runs on your machine: add the xfea-mcp command to your assistant’s MCP servers. In Claude Desktop that is an entry in its configuration file:

{
"mcpServers": {
"xfea": {
"command": "xfea-mcp"
}
}
}

If you installed into a virtual environment, give the full path of xfea-mcp inside it. The server is started by the assistant, not by your shell, so it does not see what your shell exports: keep the API key in ~/.xfea/api_key, which it reads however it is started.

Terminal window
xfea version
Terminal window
xfea meshers
Terminal window
xfea viewers

xfea meshers should list gmsh, and xfea viewers browser and paraview.

xfea backends lists solver plugins installed locally with a licence. An empty list is normal: solving then goes through the conversion service.

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