Metadata-Version: 2.3
Name: hotopy
Version: 0.23
Summary: A toolbox for X-ray holo-tomography in Python
Author: Jens Lucht, Paul Meyer, Leon M. Lohse
Author-email: Jens Lucht <jens.lucht@uni-goettingen.de>, Paul Meyer <paul.meyer@uni-goettingen.de>, Leon M. Lohse <llohse@uni-goettingen.de>
License: GPL-3.0-or-later
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: numpy>=2
Requires-Dist: pooch>=1.2
Requires-Dist: torch
Requires-Dist: scikit-image
Requires-Dist: tqdm
Requires-Dist: ptwt
Requires-Dist: ruff>=0.7.2 ; extra == 'dev'
Requires-Dist: pre-commit>=4.1.0 ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: ipykernel ; extra == 'docs'
Requires-Dist: astra-toolbox>=2.3.0 ; extra == 'tomo'
Requires-Python: >=3.10
Project-URL: documentation, https://irp.pages.gwdg.de/hotopy/
Project-URL: homepage, https://gitlab.gwdg.de/irp/hotopy
Project-URL: repository, https://gitlab.gwdg.de/irp/hotopy.git
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: tomo
Description-Content-Type: text/markdown

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

# HoToPy

## Installation

### pip installation

HoToPy can be installed through pip by running
```commandline
pip install hotopy
```
for a basic HoToPy installation. 

The basic version does not contain the [`astra-toolbox`][astra] for tomographic reconstructions. If you intend to use
the _tomographic reconstruction functions_ in `hotopy.tomo` you can install its dependencies either by running
```commandline
pip install hotopy[tomo]
```
or you can have a look at the [astra-toolbox][astra] documentation for an installation method that fits your needs.

## Getting started

You can find examples in the dedicated [HoToPy-Examples repository](https://gitlab.gwdg.de/irp/hotopy-examples).

## Documentation

https://irp.pages.gwdg.de/hotopy/

## Paper & Citation

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

```
@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},
}
```

[holotomo]: https://gitlab.gwdg.de/irp/holotomotoolbox
[astra]: https://astra-toolbox.com/
[paper]: https://doi.org/10.1107/S1600577525008550
