[](https://radicalpy.readthedocs.io/en/latest/?badge=latest)
# RadicalPy: a toolbox for radical pair spin dynamics
RadicalPy in an intuitive (object-oriented) open-source Python
framework specific to radical pair spin dynamics.
To get started take a look at the [quick start
guide](https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/docs/quick-start/guide.org)
or the
[examples](https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/examples).
The package is under constant development. [documentation](https://radicalpy.readthedocs.io/) is
up-to-date, testing partial.
If you would like to contact us, please visit the Spin Chemistry Community [Discord server](https://discord.gg/NZdjhFS3Es).
## Installation
Install simply using `pip`:
```
pip install radicalpy
```
## How to cite this software
If you used this software in your work, please cite [our paper](https://pubs.acs.org/doi/full/10.1021/acs.jctc.4c00887) (see this [bib file](CITATION.bib)).
## Reporting issues
If you find errors, bugs, omissions in the code or the documentation, or if you'd like to request a feature, or just have feedback on how we could improve things, please don't hesitate to contact us by creating an [issue](https://github.com/Spin-Chemistry-Labs/radicalpy/issues) (pull requests are also welcome).
# IMPORTANT NOTICE 2025-07-17
MANUAL INTERVENTION REQUIRED. We had some large files in the GitHub history, and to delete them, we needed to do a `git push --force`. As a consequence, if you've cloned the repo, and try `git pull`, you'll get an error about divergent branches (or something similar). What you need to do is:
```
git fetch --all # download the repo with full history from github
git reset origin/main # or origin/<THE_BRANCH_YOU'RE_ON>
```
Git will reset your local history, to match the force-pushed history from GitHub.
**OR IF YOU'RE NOT SURE YOU CAN ALWAYS DELETE AND CLONE AGAIN!**
Raw data
{
"_id": null,
"home_page": null,
"name": "radicalpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Emil Vatai <emil.vatai@gmail.com>, \"Lewis M. Antill\" <lewismantill@gmail.com>",
"keywords": "simulation, spin-dynamics, radical pairs",
"author": null,
"author_email": "\"Lewis M. Antill\" <lewismantill@gmail.com>, Emil Vatai <emil.vatai@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/81/a2/1777255815cd37fdeb6355e9a23c5200e6d04ea798f63cd3d633c592a5c4/radicalpy-1.0.4.tar.gz",
"platform": null,
"description": "[](https://radicalpy.readthedocs.io/en/latest/?badge=latest)\n\n# RadicalPy: a toolbox for radical pair spin dynamics\n\nRadicalPy in an intuitive (object-oriented) open-source Python\nframework specific to radical pair spin dynamics.\n\nTo get started take a look at the [quick start\nguide](https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/docs/quick-start/guide.org)\nor the\n[examples](https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/examples).\n\nThe package is under constant development. [documentation](https://radicalpy.readthedocs.io/) is\nup-to-date, testing partial.\n\nIf you would like to contact us, please visit the Spin Chemistry Community [Discord server](https://discord.gg/NZdjhFS3Es).\n\n## Installation\n\nInstall simply using `pip`:\n\n```\npip install radicalpy\n```\n\n## How to cite this software\n\nIf you used this software in your work, please cite [our paper](https://pubs.acs.org/doi/full/10.1021/acs.jctc.4c00887) (see this [bib file](CITATION.bib)).\n\n## Reporting issues\n\nIf you find errors, bugs, omissions in the code or the documentation, or if you'd like to request a feature, or just have feedback on how we could improve things, please don't hesitate to contact us by creating an [issue](https://github.com/Spin-Chemistry-Labs/radicalpy/issues) (pull requests are also welcome).\n\n# IMPORTANT NOTICE 2025-07-17\n\nMANUAL INTERVENTION REQUIRED. We had some large files in the GitHub history, and to delete them, we needed to do a `git push --force`. As a consequence, if you've cloned the repo, and try `git pull`, you'll get an error about divergent branches (or something similar). What you need to do is:\n\n```\ngit fetch --all # download the repo with full history from github\ngit reset origin/main # or origin/<THE_BRANCH_YOU'RE_ON>\n```\n\nGit will reset your local history, to match the force-pushed history from GitHub.\n\n**OR IF YOU'RE NOT SURE YOU CAN ALWAYS DELETE AND CLONE AGAIN!**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "RadicalPy: a toolbox for radical pair spin dynamics",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://radicalpy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Spin-Chemistry-Labs/radicalpy",
"Source": "https://github.com/Spin-Chemistry-Labs/radicalpy"
},
"split_keywords": [
"simulation",
" spin-dynamics",
" radical pairs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "980b06f38171d48c8be8c7957f2cd2d1227a7abcbbd1755481a483a14408c741",
"md5": "ab77df932d7c38027983257762b5eccd",
"sha256": "682013ef2b8903f4b82979ed55524074cb30252b337fdc8db788ca78d4b7b7c2"
},
"downloads": -1,
"filename": "radicalpy-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab77df932d7c38027983257762b5eccd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 122260,
"upload_time": "2025-11-03T07:25:16",
"upload_time_iso_8601": "2025-11-03T07:25:16.201744Z",
"url": "https://files.pythonhosted.org/packages/98/0b/06f38171d48c8be8c7957f2cd2d1227a7abcbbd1755481a483a14408c741/radicalpy-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "81a21777255815cd37fdeb6355e9a23c5200e6d04ea798f63cd3d633c592a5c4",
"md5": "0fa33bad661a2a4a6160c3822588ab65",
"sha256": "830aaf8929221eb7434aec943b020a3ed3b82a150b3d665ca7c7df772b778f41"
},
"downloads": -1,
"filename": "radicalpy-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "0fa33bad661a2a4a6160c3822588ab65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 124674,
"upload_time": "2025-11-03T07:25:17",
"upload_time_iso_8601": "2025-11-03T07:25:17.252015Z",
"url": "https://files.pythonhosted.org/packages/81/a2/1777255815cd37fdeb6355e9a23c5200e6d04ea798f63cd3d633c592a5c4/radicalpy-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-03 07:25:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Spin-Chemistry-Labs",
"github_project": "radicalpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "importlib_resources",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pint",
"specs": []
},
{
"name": "scikit-learn",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "seaborn",
"specs": []
},
{
"name": "sympy",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "graphviz",
"specs": []
},
{
"name": "dot2tex",
"specs": []
},
{
"name": "rdkit",
"specs": []
},
{
"name": "MDAnalysis",
"specs": []
}
],
"lcname": "radicalpy"
}
JSON
