Skip to main content

Collection of algorithms and functions for ultrafast electron diffraction

Project description

Windows Build Status Documentation Build Status PyPI Version

Collection of algorithms and functions for ultrafast electron diffraction. It aims to be a fully-tested package taking advantage of Python’s most recent features.

For examples, see our tutorials.

API Reference

The API Reference on readthedocs.io provides API-level documentation, as well as tutorials.

Installation

scikit-ued is available on PyPI; it can be installed with pip.:

python -m pip install scikit-ued

To install the latest development version from Github:

python -m pip install git+git://github.com/LaurentRDC/scikit-ued.git

Each version is tested against Python 3.5 and 3.6. If you are using a different version, tests can be run using the standard library’s unittest module.

Dependencies for scikit-ued (e.g. spglib) require compilation. Windows users should minimally have the Visual Studio Build Tools installed. Don’t forget to update setuptools to the latest version to avoid common problems involving C-extensions on Windows:

python -m pip install --upgrade setuptools

After installing scikit-ued you can use it like any other Python module as skued.

Optional dependencies

While it is not strictly required, the Fourier transform routines from pyfftw will be preferred If pyfftw is installed.

For displaying diffraction images using the skued.diffshow function, PyQtGraph and PyQt5 are both required.

Citations

If you are using the baseline-removal functionality of scikit-ued, please consider citing the following publication:

Support / Report Issues

All support requests and issue reports should be filed on Github as an issue.

License

scikit-ued is made available under the MIT License. For more details, see LICENSE.txt.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

scikit_ued-0.5.8-py3-none-any.whl (291.7 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