EPRAYA: Python package for EPR simulation
EPRAYA offers the tools for simulations, fitting and manipulation of EPR (Electron Paramagnetic Resonance) spectroscopic data (cw EPR) in Python. Using only three containers: Ham, Exp and Vary, users can insert hamiltonian parameters, experimental conditions and range for parameters' variation.
It also offers two modes for simulation:
Classic (CPU): Based in numpy arrays and scipy functions in parallel for simulation and fitting.
With JAX: Based in the JAX package for more efficient calculation and fitting with the ADAM algorithm (GPU use is recommended for faster results).
Installation
The recommended installation method is:
pip install epraya
We recommend to use code editors that support tkinter and plotly (VS Code, Jupyter) to take full advantage of the functions in the package. However, it's possible to use the package in any other code editors.
For further instructions on installation and common question, see the documentation.
Features
- Simulation of cw EPR single or multiple spin systems of powder or cristal samples.
- Interactive interface for data inspection and manipulation with ease.
- Identification of energy levels and resonant fields.
- Data fitting with Nelder Mead, Metropolis, Genetic Algorithm, Least Squares and ADAM.
- Plots angular dependance, enegy diagrams, EPR intensity and Absorption curves.
- JAX implemenetation for GPU compatability.
Documentation
Functions description, tutorials and more specific information, can be access in the documentation.
Limitations
- Current version of EPRAYA only supports cw EPR. We are working in implementing ENDOR and pulse EPR.
- EPRAYA supports the simulation to at most 4 interactive spin systems in classic mode and 2 systems with JAX. We expect to improve the calculation times and the possibility to simulate more systems following versions.
- For easier data manipulation, plotly and tkinter support is required.
Contributions
EPRAYA is a open-code project and contributions are welcome. If you find an error or bug, would like to improve the code or make the documentation clearer, please let us know by opening an issue or pull request.
Authors
EPRAYA is a project of the Física Aplicada group of the Universidad Nacional de Colombia. The principal contributors to the project are: Juan Sebastián Castro, Ovidio Almanza and Miguel E. Gámez.
License
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file epraya-0.1.40.1810.tar.gz.
File metadata
- Download URL: epraya-0.1.40.1810.tar.gz
- Upload date:
- Size: 120.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6740581447f05cfaeafe9e044168352c6c4cceefad21dcebb286f439e65e31d4
|
|
| MD5 |
aec05e8054d659dec0c1da407408af83
|
|
| BLAKE2b-256 |
3d182ed9eaeaed754f56d317d1b46d80a8e7956e0d04f8a0bbbb1fe09a0299e2
|
Provenance
The following attestation bundles were made for epraya-0.1.40.1810.tar.gz:
Publisher:
python-publish.yml on eprayadev/EPRAYA
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
epraya-0.1.40.1810.tar.gz -
Subject digest:
6740581447f05cfaeafe9e044168352c6c4cceefad21dcebb286f439e65e31d4 - Sigstore transparency entry: 2628151990
- Sigstore integration time:
-
Permalink:
eprayadev/EPRAYA@b0060bbe8e90e2c6a296194a20d147ff5c7645ab -
Branch / Tag:
refs/tags/0.1.40.1810 - Owner: https://github.com/eprayadev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@b0060bbe8e90e2c6a296194a20d147ff5c7645ab -
Trigger Event:
release
-
Statement type:
File details
Details for the file epraya-0.1.40.1810-py3-none-any.whl.
File metadata
- Download URL: epraya-0.1.40.1810-py3-none-any.whl
- Upload date:
- Size: 125.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30be258077fa6d6a09e525839927e66fa2eb38a42235b3447e42913af6b7ce30
|
|
| MD5 |
5c15628191591355f1b129fae2adee86
|
|
| BLAKE2b-256 |
61a95c8b3fedafc1be521f57f81bc970e6066fb2b211e12a8bfcf715c0585ab7
|
Provenance
The following attestation bundles were made for epraya-0.1.40.1810-py3-none-any.whl:
Publisher:
python-publish.yml on eprayadev/EPRAYA
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
epraya-0.1.40.1810-py3-none-any.whl -
Subject digest:
30be258077fa6d6a09e525839927e66fa2eb38a42235b3447e42913af6b7ce30 - Sigstore transparency entry: 2628151999
- Sigstore integration time:
-
Permalink:
eprayadev/EPRAYA@b0060bbe8e90e2c6a296194a20d147ff5c7645ab -
Branch / Tag:
refs/tags/0.1.40.1810 - Owner: https://github.com/eprayadev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@b0060bbe8e90e2c6a296194a20d147ff5c7645ab -
Trigger Event:
release
-
Statement type:
