Metadata-Version: 2.4
Name: qpretrieve
Version: 0.7.0
Summary: library for phase retrieval from holograms
Author-email: Paul Müller <dev@craban.de>, Eoghan O'Connell <eoclives@hotmail.com>
License: MIT
Project-URL: Repository, https://github.com/RI-imaging/qpretrieve
Project-URL: Documentation, https://qpretrieve.readthedocs.io/en/stable/
Project-URL: Changelog, https://github.com/RI-imaging/qpretrieve/blob/main/CHANGELOG
Keywords: digital holographic microscopy,optics,quantitative phase imaging,refractive index,numerical focusing,scattering
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: <4,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy>=1.9.0
Requires-Dist: scikit-image>=0.11.0
Requires-Dist: scipy>=0.18.0
Provides-Extra: fftw
Requires-Dist: pyfftw>=0.12.0; extra == "fftw"
Provides-Extra: cupy
Requires-Dist: cupy-cuda12x; platform_system != "Darwin" and extra == "cupy"
Dynamic: license-file

qpretrieve
==========

|PyPI Version| |Tests Status| |Coverage Status| |Docs Status|


**qpretrieve** is a Python3 library for Fourier-based retrieval of quantitative
phase information from experimental data. If you are looking for a library to
load quantitative phase data from various file formats, please take a glance at
`qpformat <https://github.com/RI-imaging/qpformat>`__.


Documentation
-------------

The documentation, including the code reference and examples, is available at
`qpretrieve.readthedocs.io <https://qpretrieve.readthedocs.io/en/stable/>`__.


Installation
------------

::

    pip install qpretrieve

For information on optional dependencies (FFTW, CuPy) see the
`installation guide <https://qpretrieve.readthedocs.io/en/stable/sec_installation.html>`__

Testing
-------

::

    pip install pytest
    pip install -e .
    pytest tests


.. |PyPI Version| image:: https://img.shields.io/pypi/v/qpretrieve.svg
   :target: https://pypi.python.org/pypi/qpretrieve
.. |Tests Status| image:: https://img.shields.io/github/actions/workflow/status/RI-Imaging/qpretrieve/check.yml
   :target: https://github.com/RI-Imaging/qpretrieve/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/RI-imaging/qpretrieve/master.svg
   :target: https://codecov.io/gh/RI-imaging/qpretrieve
.. |Docs Status| image:: https://readthedocs.org/projects/qpretrieve/badge/?version=latest
   :target: https://readthedocs.org/projects/qpretrieve/builds/

