Skip to main content

📻 diff-epr: Differentiable EPR/DEER Simulation in JAX

Tests License: MIT JAX

diff-epr provides differentiable kernels for simulating EPR distance distributions (DEER/PELDOR) from structural ensembles and spin-label rotamers.


🎯 Features

  • Spin-Label Modeling: Differentiable distance calculations between paramagnetic centers.
  • Orientation Selection: Support for the Polyhach 5-angle formula (Polyhach et al., 2007) to model relative domain orientations.
  • Time-Domain Simulation: Simulate DEER modulation traces $V(t)$ with parameterizable background decay and modulation depth.
  • Rotamer Library Integration: Support for weighted rotamer averages in distance distribution calculations.
  • Hardware Acceleration: GPU-optimized distance kernels via JAX.

📚 Tutorials

Experience diff-epr directly in your browser:

  • Open In Colab DEER Spectroscopy Simulation — Learn how to simulate time-domain traces from distance distributions and rotamer clouds.

🏗️ Technical Architecture

  • Backend: JAX (XLA-compiled).
  • Physics: Dipolar coupling frequency ($\omega$) based kernels.
  • Performance: $O(N)$ scaling for distance distribution integration.

🚀 Roadmap

  • Core DEER trace simulation kernels.
  • Background decay and modulation depth parameters.
  • Integration with MMM (Multi-Scale Modeling of Macromolecules) rotamer libraries.
  • Full orientation-dependence support.

🚀 Installation

pip install diff-epr

🧪 Scientific Validation

  • Dipolar Frequency Parity: Coupling frequencies verified against the Pake pattern $1/r^3$ dependence.
  • Time-Domain Accuracy: DEER traces validated for parity against standard simulation tools (e.g., DeerAnalysis/MMM).
  • Auto-Diff Gradients: Differentiable distance-to-signal kernels verified with JAX grad.

diff-epr is part of the differentiable biophysics ecosystem:


📖 Citation

@software{diff_epr,
  author  = {Elkins, George},
  title   = {diff-epr: Differentiable EPR/DEER simulation in JAX},
  year    = {2026},
  url     = {https://github.com/elkins-lab/diff-epr},
  version = {0.1.2}
}

⚖️ License

MIT

Metadata

Release files for diff-epr 0.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 diff-epr 0.1.2
File Size Uploaded Provenance Actions
diff_epr-0.1.2.tar.gz 7.8 kB With provenance Details for diff_epr-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for diff-epr 0.1.2
File Interpreter ABI Platform Actions
diff_epr-0.1.2-py3-none-any.whl Python 3 none any Details for diff_epr-0.1.2-py3-none-any.whl

Total release size: 13.8 kB

Release files / diff_epr-0.1.2.tar.gz

Download URL diff_epr-0.1.2.tar.gz
Size 7.8 kB
Tags Source
SHA-256 checksum
How to use checksums
991f78efcd93466edd5363f90f76a3f8247c069173833fee2a168bb1f1306f48
BLAKE2b-256 checksum
How to use checksums
22185d456d48b6a049113c1079cbd05ac8a72b7385d69bb8f1d4488683ce6f0b
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 1, 2026.

Transparency log

Release files / diff_epr-0.1.2-py3-none-any.whl

Download URL diff_epr-0.1.2-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f691db685eb36cfa94aa89a425509e4c5692ba80c92ced6c95ebc7f92a85ebc5
BLAKE2b-256 checksum
How to use checksums
78cdc3d096bd138b9ac3406e92e001cc7ee557a4a06297e82fafce2bc85ad896
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 1, 2026.

Transparency log

Security for diff-epr 0.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 diff_epr-0.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 Jul 1, 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