hotopy 0.25.1

A toolbox for X-ray holo-tomography in Python

HoToPy - A toolbox for X-ray holo-tomography in Python

HoToPy

Documentation

Check out the online documentation at: https://irp.pages.gwdg.de/hotopy/reference.

Installation

We recommend to install HoToPy in a dedicated Python virtual environment, which can be created using uv venv or vanilla Python venv python3 -m venv.

pip installation

HoToPy can be installed through pip by running

pip install hotopy

for a basic HoToPy installation.

Tomography backend

The base installation of HoToPy does not contain a tomography backend. If you intend to use the tomographic functions in hotopy.tomo, you need to install the ASTRA toolbox as tomographic backend.

It can be conveniently installed through the optional dependency tomo of HoToPy by running:

pip install hotopy[tomo]

Alternative installation methods of the ASTRA toolbox can be found in its documentation.

PyTorch CUDA version

uv

You can use Astral's uv (an extremely fast Python package and project manager) built-in features to install different versions of CUDA backends. Consult their uv PyTorch integration documentation for details.

For example, you can explicitly request PyTorch with CUDA-13.0 with:

uv pip install hotopy --torch-backend=cu130

Replace cu130 with your desired version, e.g. cpu, cu126, cu128, etc. See available targets. Also, an automatic PyTorch backend selection is possible with auto.

pip

We strongly recommend using the uv tool, see above.

For pip-based installation, you can use the index URLs provided by the PyTorch project, see their Getting started documentation. For example, you can install HoToPy with PyTorch using CUDA-13.0 by running:

pip install hotopy --index-url https://download.pytorch.org/whl/cu130 --extra-index-url https://pypi.org/simple/

Replace cu130 with your desired version, e.g. cpu, cu126, cu128, etc. See available targets.

Source installations

You can also install bleeding-edge versions of HoToPy by cloning the repository.

git clone https://gitlab.gwdg.de/irp/hotopy.git
cd hotopy
uv pip install '.[tomo,dev]'

Here, the optional dependencies for tomography and development (dev) are included in the installation. You may add the --editable flag to the installation, for an editable development deployment.

Getting started

You can find examples in the dedicated HoToPy-Examples repository.

Paper & Citation

If you use HoToPy, please cite the paper HoToPy: a toolbox for X-ray holo-tomography in Python

@article{Lucht2025_hotopy,
    author = "Lucht, Jens and Meyer, Paul and Lohse, Leon Merten and Salditt, Tim",
    title = "{{\it HoToPy}: a toolbox for X-ray holo-tomography in Python}",
    journal = "Journal of Synchrotron Radiation",
    year = "2025",
    volume = "32",
    number = "6",
    pages = "1586--1594",
    month = "Nov",
    doi = {10.1107/S1600577525008550},
    url = {https://doi.org/10.1107/S1600577525008550},
    keywords = {X-ray imaging, phase retrieval, computed tomography, phase contrast, holography},
}