Installation

Requirements

• Python 3.13+
• uv (recommended) or pip for installation

Install from PyPI (recommended)

The stable release is available on PyPI:

pip install xeltofab

With optional extras:

pip install "xeltofab[vtk,hdf5]"

Or using uv:

uv add xeltofab

Install from source (development)

For the latest development version or to contribute:

git clone https://github.com/xarthurx/XelToFab.git
cd XelToFab
uv sync

This installs all core dependencies: numpy, scipy, scikit-image, trimesh, pydantic, matplotlib, and click.

You can also install the development version directly from GitHub:

pip install git+https://github.com/xarthurx/XelToFab.git

Or with uv:

uv add git+https://github.com/xarthurx/XelToFab.git

Optional format support

Some input formats require additional libraries. Install everything at once:

uv sync --all-extras

Or install individual extras selectively:

Verify installation

Check that the CLI is available and see which formats are ready:

uv run xtf --help

List all supported input formats and their availability status:

uv run xtf formats

See xtf formats for the full list of supported formats and their dependencies.

Running tests

uv run pytest tests/ -v