Metadata-Version: 2.1
Name: pysprint
Version: 0.12.5
Summary: Spectrally refined interferometry for Python
Home-page: https://github.com/Ptrskay3/PySprint
Author: Péter Leéh
Author-email: leeh123peter@gmail.com
License: UNKNOWN
Description: # PySprint
        ### Spectrally Refined Interferometry for Python 
        
        [![Build Status](https://travis-ci.org/Ptrskay3/PySprint.svg?branch=master)](https://travis-ci.org/Ptrskay3/pysprint)
        [![Build Status](https://dev.azure.com/leehpeter/PySprint/_apis/build/status/Ptrskay3.PySprint?branchName=master)](https://dev.azure.com/leehpeter/PySprint/_build/latest?definitionId=3&branchName=master)
        [![Maintainability](https://api.codeclimate.com/v1/badges/4e876c4899af3c4435b0/maintainability)](https://codeclimate.com/github/Ptrskay3/PySprint/maintainability)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Ptrskay3/PySprint.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Ptrskay3/PySprint/context:python)
        [![codecov](https://codecov.io/gh/Ptrskay3/PySprint/branch/master/graph/badge.svg)](https://codecov.io/gh/Ptrskay3/PySprint)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Documentation Status](https://readthedocs.org/projects/pysprint/badge/?version=latest)](https://pysprint.readthedocs.io/en/latest/?badge=latest)
        | | |
        |-|-|
        |__Name__| PySprint|
        |__PyPI package__| [![PyPI version](https://badge.fury.io/py/pysprint.svg)](https://badge.fury.io/py/pysprint) |
        |__Anaconda package__| [![Anaconda-Server Badge](https://anaconda.org/ptrskay/pysprint/badges/version.svg)](https://anaconda.org/ptrskay/pysprint) |
        |__Development status__ | Pre-Alpha |
        |__License__| [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
        
        
        ## Description & Features
        PySprint provides an interface for Spectrally resolved interferometry in Python.
        
        * âś“ Minimum-maximum method
        * âś“ Phase modulated cosine function fit method
        * âś“ Fourier method
        * âś“ Windowed Fourier transform method
        * âś“ Stationary phase point method
        
        ### There's many more to work on..
        * SPP detection
        * WFT ridge detection improvement
        * Better SPP interface: make the constructor accept `~pysprint.Dataset` objects.
        * Improve file parsing
        * Clean up utils, evaluate methods, preprocess methods
        * Clean up plot utilities
        * Integrate `~pysprint.core.phase.Phase` into methods.
        * Write understandable and consistent docstrings
        
        This is a work-in-progress version of the package.
        
        ### Installation
        
        PySprint requires at least [Python 3.6](https://www.python.org/downloads/) to run.
        
        Install with
        
        ```sh
        pip install pysprint
        ```
        
        or install on Anaconda with:
        ```sh
        conda install -c ptrskay pysprint -c conda-forge
        ```
        
        Requirements: 
        * numpy
        * scipy
        * matplotlib 
        * pandas
        
        Optional packages: 
        * lmfit - for detailed curve fitting results
        * numba - to speed up non uniform FFT calculation
        
        
        ## Documentation
        
        The documentation is hosted on readthedocs.io.
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Description-Content-Type: text/markdown
Provides-Extra: optional
