Metadata-Version: 2.1
Name: pyrost
Version: 0.1.11
Summary: UNKNOWN
Home-page: https://github.com/simply-nicky/pyrost
Author: Nikolay Ivanov
Author-email: nikolay.ivanov@desy.de
License: UNKNOWN
Description: ## Current build status
        [![PyPI](https://img.shields.io/pypi/v/pyrost?color=brightgreen)](https://pypi.org/project/pyrost/)
        [![Documentation Status](https://readthedocs.org/projects/robust-speckle-tracking/badge/?version=latest)](https://robust-speckle-tracking.readthedocs.io/en/latest/?badge=latest)
        
        # pyrost
        Python Robust Speckle Tracking (**pyrost**) is a library for wavefront metrology
        and sample imaging based on ptychographic speckle tracking algorithm. This
        project takes over Andrew Morgan's [speckle_tracking](https://github.com/andyofmelbourne/speckle-tracking)
        project as an improved version aiming to add robustness to the optimisation
        algorithm in the case of the high noise present in the measured data.
        
        The documentation can be found on [Read the Docs](https://robust-speckle-tracking.readthedocs.io/en/latest/).
        
        ## Dependencies
        
        - [Python](https://www.python.org/) 3.6 or later (Python 2.x is **not** supported).
        - [GNU Scientific Library](https://www.gnu.org/software/gsl/) 2.4 or later.
        - [LLVM's OpenMP library](http://openmp.llvm.org) 10.0.0 or later.
        - [h5py](https://www.h5py.org) 2.10.0 or later.
        - [NumPy](https://numpy.org) 1.19.0 or later.
        - [SciPy](https://scipy.org) 1.5.2 or later.
        
        ## Installation
        We recommend **not** building from source, but install the release from [pypi](https://pypi.org/project/pyrost/)
        with the pip package installer:
        
            pip install pyrost
        
        Pre-build binary wheels for OS X are available in [pypi](https://pypi.org/project/pyrost/) as for now.
        
        ## Installation from source
        In order to build the package from source simply execute the following command:
        
            python setup.py install
        
        or:
        
            pip install -r requirements.txt -e . -v
        
        That cythonizes the Cython extensions and builds them into ``/pyrost/bin``.
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: interactive
