Metadata-Version: 2.4
Name: nrefocus
Version: 0.6.0
Summary: numerical focusing (refocusing, autofocusing) of complex wave fields
Author-email: Paul Müller <dev@craban.de>, Eoghan O'Connell <eoclives@hotmail.com>
License: BSD (3 clause)
Project-URL: Repository, https://github.com/RI-imaging/nrefocus
Project-URL: Documentation, https://nrefocus.readthedocs.io/en/stable/
Project-URL: Changelog, https://github.com/RI-imaging/nrefocus/blob/master/CHANGELOG
Keywords: autofocus,refocus,numerical focusing,quantitative phase imaging,digital holographic microscopy
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: <4,>=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: lmfit
Requires-Dist: numexpr
Requires-Dist: numpy>=1.5.1
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

nrefocus
========

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

Numerically (auto)refocus complex wave fields, such as those acquired using
quantitative phase imaging techniques in modern microscopy.


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

The documentation is available is available at
`nrefocus.readthedocs.io <https://nrefocus.readthedocs.io/en/stable/>`__.


Installation
------------
Install from the Python package index (the `FFTW` extra enables fast
Fourer transforms with `PyFFTW <https://pyfftw.readthedocs.io/>`__)::

    pip install nrefocus[FFTW]

or clone the repository and run::

    pip install -e .[FFTW]


Testing
-------
Testing is done with pytest::

    pip install pytest
    pytest tests



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