Skip to main content

PyEPR

PyPI - Version DOI

About

PyEPR is a Python based software package for designing, running and processing EPR experiments on a wide variety of hardware. It is built to be modular and extensible, allowing easy integration of new hardware and experiment types. PyEPR is developed by the Jeschke Lab @ ETH. To extend the functionality of PyEPR we are actively looking for contributors.

PyEPR currently supports BRUKER ElexSys spectrometers running Xepr 2.9 and Andrin Doll style homebuilt spectrometers running Matlab based control software. Extending support for new hardware is straightforward and we are happy to assist anyone interested in doing so.

PyEPR was developed to provide the hardware abstraction layer for autoDEER, a software package for running automated DEER experiments. However, PyEPR can also be used as a general purpose EPR data processing and simulation library.

Features

  • Fully python based, open-source and free to use
  • Intuitive object-oriented pulse sequencer
  • Pre-defined common EPR experiments (CW, Hahn Echo, Inversion Recovery, Carr-Purcell, DEER, etc.)
  • Easy to define custom experiments
  • Pre-defined common pulse shapes (rectangular, Gaussian, sech/tanh, etc.)
  • Easy to define custom pulse shapes
  • Hardware abstraction layer for interfacing with different spectrometers
  • BRUKER PulseSpel compiler from PyEPR sequences

Installation

It is recommended to install PyEPR in a virtual environment, from source.

Dependencies

  • numpy
  • scipy
  • matplotlib
  • DeerLab
  • pyyaml
  • xarray
  • h5netcdf
  • toml
  • psutil

Requirements

PyEPR is generally compatible with Windows, Mac and Linux and requires Python 3.11 or 3.12. Support for new Python versions will only be added once they become stable, and have been fully tested with PyEPR. This can take some time, so please be patient. The specific hardware implementation may add additional limitations for example, when using XeprAPI a modern Linux OS is required.

Citing PyEPR

At the moment, no paper is associated with PyEPR. Once published, it will be linked here. It is kindly requested that in the meantime the appropriate DOI number is cited. The associated Zotero entry is available here.

Citing academic software is important as it helps to ensure the long-term sustainability of the software, and allows the developers to track the impact of their work and secure future funding. It also helps to provide credit to the developers for their hard work.

Contributing

Contributions to PyEPR are welcome! If you have discovered an issue or have a feature request, please open an issue on the GitHub repository. If you would like to contribute code, please fork the repository and submit a pull request. If you have any questions or need help, please open an issue or contact the authors.

License

PyEPR is licensed under the GNU GPLv3 public license, and is released without warranty or liability. Commercial use is allowed, however it is advised to contact the authors for support.

Copyright © 2021-2025: Hugo Karas, Stefan Stoll and Gunnar Jeschke

Metadata

Release files for pyEPR-ESR 1.2

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

Source distribution (sdist)

Source distribution for pyEPR-ESR 1.2
File Size Uploaded Provenance Actions
pyepr_esr-1.2.tar.gz 400.6 kB With provenance Details for pyepr_esr-1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyEPR-ESR 1.2
File Interpreter ABI Platform Actions
pyepr_esr-1.2-py3-none-any.whl Python 3 none any Details for pyepr_esr-1.2-py3-none-any.whl

Total release size: 566.8 kB

Release files / pyepr_esr-1.2.tar.gz

Download URL pyepr_esr-1.2.tar.gz
Size 400.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c6b87917e4b25cdb0f28b6c3daa56603bb0f1691b2247eb0af47c6d8a541ffdb
BLAKE2b-256 checksum
How to use checksums
00a0a4ae183465b32a7c107d2fa2607ea4c9c67e3cf33507072af5fbfefbee89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

Release files / pyepr_esr-1.2-py3-none-any.whl

Download URL pyepr_esr-1.2-py3-none-any.whl
Size 166.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5cf2fb489e813b1783c0807e10168f73a2b58673efd390e450de1304ab21adb0
BLAKE2b-256 checksum
How to use checksums
205e2b2e6bfd28bd148cf8f48291166daa9ff718694fd76578c5be953f8989d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

Security for pyEPR-ESR 1.2

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyepr_esr-1.2.tar.gz

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 Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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