Skip to main content

Spectrally refined interferometry for Python

Project description

PySprint

Spectrally Refined Interferometry for Python

Build Status Build Status Maintainability Language grade: Python codecov Code style: black Documentation Status

Name PySprint
PyPI package PyPI version
Anaconda package Anaconda-Server Badge
Development status Pre-Alpha
License License: 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 to run.

Install with

pip install pysprint

or install on Anaconda with:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysprint-0.12.4.tar.gz (2.5 MB view hashes)

Uploaded Source

Built Distribution

pysprint-0.12.4-py3-none-any.whl (326.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page