# DeerLab
[](https://pypi.org/project/DeerLab/)
[](https://jeschkelab.github.io/DeerLab/)
[](https://www.python.org/downloads/)
## About
DeerLab is a comprehensive free scientific software package for Python focused on modeling, penalized least-squares regression, and uncertainty quantification.
It provides highly specialized on the analysis of dipolar EPR (electron paramagnetic resonance) spectroscopy data. Dipolar EPR spectroscopy techniques include DEER (double electron-electron resonance), RIDME (relaxation-induced dipolar modulation enhancement), and others.
The documentation can be found [here](https://jeschkelab.github.io/DeerLab/index.html).
The early versions of DeerLab (up to version 0.9.2) are written in MATLAB. The old MATLAB codebase is archived and can be found [here](https://github.com/JeschkeLab/DeerLab-Matlab).
## Requirements
DeerLab is available for Windows, Mac and Linux systems and requires **Python 3.8**, **3.9**, **3.10**, or **3.11**.
All additional dependencies are automatically downloaded and installed during the setup.
## Setup
A pre-built distribution can be installed from the PyPI repository using `pip`.
From a terminal (preferably with admin privileges) use the following command to install from PyPI:
python -m pip install deerlab
More details on the installation and updating of DeerLab can be found [here](https://jeschkelab.github.io/DeerLab/installation.html).
## Citing DeerLab
When you use DeerLab in your work, please cite the following publication:
**DeerLab: a comprehensive software package for analyzing dipolar electron paramagnetic resonance spectroscopy data** <br>
Luis Fábregas Ibáñez, Gunnar Jeschke, Stefan Stoll <br>
Magn. Reson., 1, 209–224, 2020 <br>
<a href="https://doi.org/10.5194/mr-1-209-2020"> doi.org/10.5194/mr-1-209-2020</a>
Here is the citation in bibtex format:
```tex
@article{FabregasIbanez2020_DeerLab,
title = {{DeerLab}: a comprehensive software package for analyzing dipolar electron paramagnetic resonance spectroscopy data},
author = {Fábregas Ibáñez, Luis and Jeschke, Gunnar and Stoll, Stefan},
journal = {Magnetic Resonance},
year = {2020},
volume = {1},
number = {2},
pages = {209--224},
doi = {10.5194/mr-1-209-2020}
}
```
## License
DeerLab is licensed under the [MIT License](LICENSE).
Copyright © 2019-2023: Luis Fábregas Ibáñez, Stefan Stoll, Gunnar Jeschke, and [other contributors](https://github.com/JeschkeLab/DeerLab/contributors).
Raw data
{
"_id": null,
"home_page": "https://github.com/JeschkeLab/DeerLab",
"name": "DeerLab",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "data,analysis,modeling,least-squares,EPR,spectroscopy,DEER,PELDOR",
"author": "Luis F\u00e1bregas Ib\u00e1\u00f1ez , Stefan Stoll and other contributors",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/01/ea/101ffcf199a460b601f082084c5e2f669dba2284fa698eb38e4cdbf0ca04/DeerLab-1.1.2.tar.gz",
"platform": null,
"description": "# DeerLab\n\n[](https://pypi.org/project/DeerLab/)\n[](https://jeschkelab.github.io/DeerLab/)\n[](https://www.python.org/downloads/)\n\n\n## About\n\nDeerLab is a comprehensive free scientific software package for Python focused on modeling, penalized least-squares regression, and uncertainty quantification. \nIt provides highly specialized on the analysis of dipolar EPR (electron paramagnetic resonance) spectroscopy data. Dipolar EPR spectroscopy techniques include DEER (double electron-electron resonance), RIDME (relaxation-induced dipolar modulation enhancement), and others. \n\nThe documentation can be found [here](https://jeschkelab.github.io/DeerLab/index.html).\n\nThe early versions of DeerLab (up to version 0.9.2) are written in MATLAB. The old MATLAB codebase is archived and can be found [here](https://github.com/JeschkeLab/DeerLab-Matlab).\n\n## Requirements\n\nDeerLab is available for Windows, Mac and Linux systems and requires **Python 3.8**, **3.9**, **3.10**, or **3.11**.\n\nAll additional dependencies are automatically downloaded and installed during the setup.\n \n## Setup\n\nA pre-built distribution can be installed from the PyPI repository using `pip`.\n\nFrom a terminal (preferably with admin privileges) use the following command to install from PyPI:\n\n python -m pip install deerlab\n\nMore details on the installation and updating of DeerLab can be found [here](https://jeschkelab.github.io/DeerLab/installation.html).\n\n## Citing DeerLab\n\nWhen you use DeerLab in your work, please cite the following publication:\n\n **DeerLab: a comprehensive software package for analyzing dipolar electron paramagnetic resonance spectroscopy data** <br>\n Luis F\u00e1bregas Ib\u00e1\u00f1ez, Gunnar Jeschke, Stefan Stoll <br>\n Magn. Reson., 1, 209\u2013224, 2020 <br>\n <a href=\"https://doi.org/10.5194/mr-1-209-2020\"> doi.org/10.5194/mr-1-209-2020</a>\n\nHere is the citation in bibtex format:\n\n```tex\n@article{FabregasIbanez2020_DeerLab,\n title = {{DeerLab}: a comprehensive software package for analyzing dipolar electron paramagnetic resonance spectroscopy data},\n author = {F\u00e1bregas Ib\u00e1\u00f1ez, Luis and Jeschke, Gunnar and Stoll, Stefan},\n journal = {Magnetic Resonance},\n year = {2020},\n volume = {1},\n number = {2},\n pages = {209--224},\n doi = {10.5194/mr-1-209-2020}\n}\n```\n\n## License\n\nDeerLab is licensed under the [MIT License](LICENSE).\n\nCopyright \u00a9 2019-2023: Luis F\u00e1bregas Ib\u00e1\u00f1ez, Stefan Stoll, Gunnar Jeschke, and [other contributors](https://github.com/JeschkeLab/DeerLab/contributors).\n",
"bugtrack_url": null,
"license": "LICENSE.txt",
"summary": "Comprehensive package for data analysis of dipolar EPR spectroscopy",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://jeschkelab.github.io/DeerLab/",
"Homepage": "https://github.com/JeschkeLab/DeerLab",
"Source": "https://github.com/JeschkeLab/DeerLab"
},
"split_keywords": [
"data",
"analysis",
"modeling",
"least-squares",
"epr",
"spectroscopy",
"deer",
"peldor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "619ca62d80509c465822b327bb4d044212847f0d4c72c30a29c836904dca6915",
"md5": "87648be757d5c31ba84db736d779a70d",
"sha256": "9ca00dfc5954fabe297cf5ae37b0ba7f1f6970a8e16e348e93c5c63e88e4200c"
},
"downloads": -1,
"filename": "DeerLab-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87648be757d5c31ba84db736d779a70d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 125704,
"upload_time": "2023-11-03T11:23:02",
"upload_time_iso_8601": "2023-11-03T11:23:02.281464Z",
"url": "https://files.pythonhosted.org/packages/61/9c/a62d80509c465822b327bb4d044212847f0d4c72c30a29c836904dca6915/DeerLab-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01ea101ffcf199a460b601f082084c5e2f669dba2284fa698eb38e4cdbf0ca04",
"md5": "15d6a4ce9ad1fdd7c7bf85b492018ad1",
"sha256": "612e7f66b78f2e2d50aeead31b38b664c2dad0fa38594d366b757f9900c27f6f"
},
"downloads": -1,
"filename": "DeerLab-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "15d6a4ce9ad1fdd7c7bf85b492018ad1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 144646,
"upload_time": "2023-11-03T11:23:03",
"upload_time_iso_8601": "2023-11-03T11:23:03.881808Z",
"url": "https://files.pythonhosted.org/packages/01/ea/101ffcf199a460b601f082084c5e2f669dba2284fa698eb38e4cdbf0ca04/DeerLab-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 11:23:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JeschkeLab",
"github_project": "DeerLab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deerlab"
}
JSON
