scikit-ued
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 also install optional dependencies required to view diffraction images interactively:
python -m pip install scikit-ued[diffshow]
scikit-ued is also available on the conda-forge channel for the conda package manager:
conda config --add channels conda-forge
conda install scikit-ued
To install the latest development version from Github:
python -m pip install git+https://github.com/LaurentRDC/scikit-ued.git
After installing scikit-ued you can use it like any other Python module
as skued.
Each version is tested against Python 3.7+. If you are using a
different version, tests can be run using the pytest package.
Optional dependencies
For displaying diffraction images with interactive contrast using the
skued.diffshow function, PyQtGraph is required.
Contributing
If you want to contribute to scikit-ued, take a look at CONTRIBUTING.md.
Related projects
Streaming operations on NumPy arrays are available in the npstreams package.
Interactive exploration of ultrafast electron diffraction data with the iris-ued package.
Crystal structure manipulation (including symmetry-determination) with the crystals package. (Included with scikit-ued)
A graphical user interface for the dual-tree complex wavelet transform baseline-removal routine is available as a separate package.
Citations
If you find this software useful, please consider citing the following publication:
L. P. René de Cotret, M. R. Otto, M. J. Stern. and B. J. Siwick, An open-source software ecosystem for the interactive exploration of ultrafast electron scattering data, Advanced Structural and Chemical Imaging 4:11 (2018) DOI: 10.1186/s40679-018-0060-y.
If you are using the baseline-removal functionality of scikit-ued, please consider citing the following publication:
L. P. René de Cotret and B. J. Siwick, A general method for baseline-removal in ultrafast electron powder diffraction data using the dual-tree complex wavelet transform, Struct. Dyn. 4 (2017) DOI: 10.1063/1.4972518.
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 GPLv3 License. For more details, see LICENSE.txt.
1 maintainer
Release files for scikit-ued 2.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scikit_ued-2.2.1.tar.gz | 264.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scikit_ued-2.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 558.6 kB
Release files / scikit_ued-2.2.1.tar.gz
| Download URL | scikit_ued-2.2.1.tar.gz |
|---|---|
| Size | 264.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ef07f41e003fa3407a02376feee74a135ed819b93f354fe77232ba8bf97dd53
|
|
BLAKE2b-256 checksum How to use checksums |
2176c353ceb5443a79c3bb8ddf732a1fbda4c0a29ee9162b4d9d46508d405842
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 19, 2026.
Transparency logRelease files / scikit_ued-2.2.1-py3-none-any.whl
| Download URL | scikit_ued-2.2.1-py3-none-any.whl |
|---|---|
| Size | 294.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4149abc016babedfdaedbbff35fdcac675f120328da1208f0d7287aa1172dc90
|
|
BLAKE2b-256 checksum How to use checksums |
81034f1a207aa89c6814813e47478893fd1ef4277a16c52c58253745e75cf70d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 19, 2026.
Transparency log
