eprbase
eprbase is a low-level Python framework for developing custom simulation
routines for continuous-wave electron paramagnetic resonance (cwEPR).
The framework provides CPU and GPU implementations of its modules with compatible interfaces. This allows individual parts of a simulation to be executed on either the CPU or GPU and combined as needed.
The code is fully object-oriented. Classes can be extended or modified through inheritance, making it possible to implement custom functionality for individual simulation requirements.
Currently, the Hamiltonian implementation is limited to radical pairs. Support for arbitrary spin systems will be added in future releases.
Features
- Low-level building blocks for custom cwEPR simulation routines
- CPU and GPU implementations with compatible interfaces
- Flexible hybrid CPU/GPU simulation workflows
- Object-oriented design
- Extensible and modifiable classes through inheritance
- Numerical calculations based on NumPy and SciPy
- GPU acceleration using CuPy
- Current support for radical-pair Hamiltonians
- Planned support for arbitrary spin systems
Requirements
- Python 3.13 or newer
Installation
Using uv
CPU version
uv add eprbase
GPU version
uv add eprbase --extra gpu
The GPU version requires a compatible NVIDIA GPU and CUDA installation.
Using pip
CPU version
pip install eprbase
GPU version
pip install eprbase[gpu]
The GPU version requires a compatible NVIDIA GPU and CUDA installation.
Development
Clone the repository and install the development dependencies with uv:
git clone https://github.com/florianquintes/eprbase.git
cd eprbase
uv sync --dev
Install the optional GPU dependencies:
uv sync --extra gpu
Run the tests:
uv run pytest
Check the code formatting and linting:
uv run ruff format --check .
uv run ruff check .
Format the code locally:
uv run ruff format .
Documentation
The documentation is available on GitHub Pages.
License
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.
Metadata
Release files for eprbase 0.1.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 | Provenance | Actions |
|---|---|---|---|---|
| eprbase-0.1.1.tar.gz | 69.8 kB | With provenance | Details for eprbase-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| eprbase-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for eprbase-0.1.1-py3-none-any.whl |
Total release size: 134.9 kB
Release files / eprbase-0.1.1.tar.gz
| Download URL | eprbase-0.1.1.tar.gz |
|---|---|
| Size | 69.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8e1974f1fd6cb9d22db32c0d55e84f419dbb7c29af9da48ddb653a4d09fc2597
|
|
BLAKE2b-256 checksum How to use checksums |
968fa5e788bd398920bcddfcb09b793ce222c64e478b682e0635f9c7c41ff9c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
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 22, 2026.
Transparency logRelease files / eprbase-0.1.1-py3-none-any.whl
| Download URL | eprbase-0.1.1-py3-none-any.whl |
|---|---|
| Size | 65.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c223adecdfb500bc4a6782d9698cf3d846737462815f48aa00ccf11779998544
|
|
BLAKE2b-256 checksum How to use checksums |
1413746a8e72ae591e7b246495bcaa282af5cdf3991e2e39abdcd44ef8f73990
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
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 22, 2026.
Transparency logSecurity for eprbase 0.1.1
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.
Attestation for eprbase-0.1.1.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 22, 2026.
Transparency logA 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.