Metadata-Version: 2.1
Name: qpretrieve
Version: 0.1.0
Summary: library for phase retrieval from holograms
Home-page: https://github.com/RI-imaging/qpretrieve
Author: Paul Müller
Author-email: dev@craban.de
License: MIT
Keywords: digital holographic microscopy,optics,quantitative phase imaging,refractive index,numerical focusing,scattering
Platform: ALL
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.6, <4
License-File: LICENSE

qpretrieve
==========

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


**qpretrieve** is a Python3 library for Fourier-based retrieval if 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


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/workflow/status/RI-Imaging/qpretrieve/Checks
   :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/



