Skip to content
This repository has been archived by the owner on Sep 1, 2024. It is now read-only.

Latest commit

 

History

History
63 lines (47 loc) · 3.68 KB

README.md

File metadata and controls

63 lines (47 loc) · 3.68 KB

PySprint

Spectrally Resolved Interferometry for Python

PySprint Maintainability Language grade: Python codecov Code style: black Documentation Status Binder

Name PySprint
PyPI package PyPI version
Anaconda package Not Maintained
Development status Beta
License License: MIT
Languages Python, Rust
Supported Python versions PyPI pyversions

Description

PySprint provides an interface for Spectrally resolved interferometry in Python. PySprint implements all the evaluation methods described in the literature, however the API and the software itself might change over time. Documentation is sparse and due to the narrow use case of the software its written in Hungarian, however it will be translated to English in the future. The testing is in very early stages.

  • Minima-maxima method
  • Phase modulated cosine function fit method
  • Fourier method
  • Windowed Fourier transform method
  • Stationary phase point method

Installation

PySprint requires at least Python 3.6 to run.

Install with

pip install pysprint

Requirements:

  • numpy
  • scipy
  • matplotlib
  • pandas
  • Jinja2
  • scikit-learn

Optional packages:

  • lmfit - for detailed curve fitting results
  • numba - to speed up non uniform FFT calculation
  • dask - for parallel WFT run

Documentation

The documentation is hosted on readthedocs.io. You may try the software without installing on binder.