Installation#

Prerequisites#

  • Python 3.10 or newer.

  • A working C/C++ build toolchain (required by xraylib).

Manual installation#

The project is published on PyPI. To install the latest release in an isolated environment:

python -m venv .ewokstomo_env
source .ewokstomo_env/bin/activate
pip install --upgrade pip
pip install ewokstomo

To install from a cloned working tree and keep editable sources:

git clone https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo.git
cd ewokstomo
pip install -e .

Optional dependency sets#

The package defines extras for common development scenarios:

  • ewokstomo[test] – installs pytest, Ewoks, and a CPU-only Nabu build.

  • ewokstomo[no_cuda] – bundles nabu[full_nocuda] for headless environments.

  • ewokstomo[cuda] – bundles nabu[full] with GPU support (requires a CUDA-capable machine).

  • ewokstomo[doc] – brings the toolchain required to build this documentation (Sphinx + PyData theme).

You can install an extra by appending it to the pip requirement, for example pip install "ewokstomo[test]".

Note

ESRF production deployment

On ESRF-operated Ewoks workers the package is rolled out through the DAU Ansible playbooks. Beamline scientists normally do not need to install ewokstomo manually.