Metadata-Version: 2.4
Name: pyphase
Version: 2.0.0
Summary: An open source phase retrieval code
Home-page: https://gitlab.in2p3.fr/mlanger/pyPhase/
Author: Max Langer
Author-email: max.langer@creatis.insa-lyon.fr
License: CeCILL FREE SOFTWARE LICENSE AGREEMENT
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: h5py
Requires-Dist: itk-elastix
Requires-Dist: jsonschema
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: Pillow
Requires-Dist: PyQt5
Requires-Dist: python-dateutil
Requires-Dist: PyYAML
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: Sphinx
Requires-Dist: sphinx-rtd-theme
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

**pyPhase** is an open-source Python package for phase retrieval from phase contrast images in the Fresnel regime. For an overview, check out the pyPhase manuscript: https://arxiv.org/abs/2012.07942

Features
========

* Phase retrieval algorithms
* Wave propagation.
* Handling of different image sources and formats
* Tools for pre-processing such as registration of phase contrast images and motion estimation


Version
=======

The latest version of PyPhase is 2.0 (the one we recommend using)

- 2.0 
   - works on Python 3.12 
   - includes more algorithms : CTF8HOM, RAAR, HPR, NLCG, IRGN, NLPDHGM, GDTV, PDHGM_CTF et ADMM_CTF
   - no longer need to install Elastix; it is automatically integrated with a Python package (itk-elastix)

- 1.0
   - works on Python 3.7
   - requires manual installation of Elastix 4.9


Installation
============

Installation is currently through PyPI. Create a virtual environment using your favourite virtual environment manager, verify that pip is installed, then:

.. code-block::

   pip install pyphase


Test your installation:

.. code-block::

   python3 import pyphase






