Skip to main content

Actions Coveralls pypi_version downloads black doi

pyxem is an open-source (GPL v3) python library for multi-dimensional diffraction microscopy.

The package defines objects and functions for the analysis of numerous diffraction patterns. It has been primarily developed as a platform for hybrid diffraction-microscopy based on 4D scanning diffraction microscopy data in which a 2D diffraction pattern is recorded at every position in a 2D scan of a specimen.

pyxem is an extension of the hyperspy library for multi-dimensional data analysis and defines diffraction specific Signal classes.

Installation instructions and tutorial examples are available here .

Basic Documentation is available here.

If analysis using pyxem forms a part of published work please cite the DOI at the top of this page. In addition to citing the package we would appreciate an additional citation to methods papers if you use the following capabilities:

Orientation Mapping

@article{pyxemorientationmapping2022,
    title={Free, flexible and fast: Orientation mapping using the multi-core and GPU-accelerated template matching capabilities in the python-based open source 4D-STEM analysis toolbox Pyxem},
    author={Cautaerts, Niels and Crout, Phillip and {\AA}nes, H{\aa}kon Wiik and Prestat, Eric and Jeong, Jiwon and Dehm, Gerhard and Liebscher, Christian H},
    journal={Ultramicroscopy},
    pages={113517},
    year={2022},
    publisher={Elsevier},
    doi={10.1016/j.ultramic.2022.113517}
}

Strain Mapping

Two-Dimensional Strain Mapping with Scanning Precession Electron Diffraction: An Investigation into Data Analysis Routines by Crout et al. which is freely avaliable at https://arxiv.org/abs/2307.01071

Release files for pyxem 0.21.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyxem 0.21.0
File Size Uploaded
pyxem-0.21.0.tar.gz 320.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyxem 0.21.0
File Interpreter ABI Platform
pyxem-0.21.0-py3-none-any.whl Python 3 none any Details

Total release size:761.9 kB

Release files / pyxem-0.21.0.tar.gz

Download URL pyxem-0.21.0.tar.gz
Size 320.6 kB
Tags Source
SHA-256 checksum
How to use checksums
a78d4fe1880c2f8033fb6b8245ce5f7a475bb8f6deede6a7c9d4ed57302b5cd4
BLAKE2b-256 checksum
How to use checksums
99728c4a07188da27ed931dbe8ccef49b6a8c6ce0f9c89c1ad37411d465ef672
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jun 4, 2025.

Transparency log

Release files / pyxem-0.21.0-py3-none-any.whl

Download URL pyxem-0.21.0-py3-none-any.whl
Size 441.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3984050c62ad1eb4d35ab64acb76d5c6596a44304bb55a90f0d5ab6f4d65cc5f
BLAKE2b-256 checksum
How to use checksums
a17b863cefd4b6da71ac9779aa727185dcf72c5af6cbc24da6eb6f7604cf295f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jun 4, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page