Metadata-Version: 2.4
Name: prtools
Version: 1.3.1
Summary: Utility functions for image-based phase retrieval
Author: Andy Kee
License: MIT License
        
        Copyright (c) 2023 Andy Kee
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/andykee/prtools
Project-URL: Documentation, https://andykee.github.io/prtools/
Project-URL: Bug Tracker, https://github.com/andykee/prtools/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: NOTICE
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: jax
Requires-Dist: jax; extra == "jax"
Requires-Dist: optax; extra == "jax"
Dynamic: license-file

prtools
=======
|pypi version|

The prtools package implements functionality and tools that may be helpful 
when performing image-based phase retrieval including:

* Image processing, reduction, and analysis
* Creating, fitting, and removing Zernike polynomials
* Drawing various shapes in arrays
* Computing statistics and optical simulation parameters

Installation
------------
Install and update prtools using `pip`_:

.. code-block:: text

    pip install prtools

Links
-----
* **Docs:** https://andykee.github.io/prtools/
* **Releases:** https://pypi.org/project/prtools/
* **Source:** https://github.com/andykee/prtools/
* **Issues:** https://github.com/andykee/prtools/issues/

.. _pip: https://pip.pypa.io/en/stable/getting-started/

.. |pypi version| image:: https://img.shields.io/pypi/v/prtools.svg
    :target: https://pypi.python.org/pypi/prtools
