ARC (Alkali.ne Rydberg Calculator)
==================================
ARC (Alkali.ne Rydberg Calculator) is package of routines written in Python, using object-oriented programming (OOP) to make modular, reusable and extendable collection of routines and data for performing useful calculations of single atom and two-atom properties, like level diagrams, interactions and transition strengths for alkali metal and divalent atoms.
Start by installing the latest version of the ARC package calling Python pip ([see prerequisites](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/installation.html)) from the command line:
```pip install ARC-Alkali-Rydberg-Calculator ```
For documentation see [online documentation on Read The Docs](http://arc-alkali-rydberg-calculator.readthedocs.io).
For examples of use check [IPython example notebooks](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/getting_started.html#ipython-notebook-with-examples).
For online access to a selection of package functions see [online Atom Calculator](https://atomcalc.org).
If you want to contribute to the project, [check this page](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/contribute.html).
 [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_linux.yaml) [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_windows.yaml) [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_macos.yaml) [](https://badge.fury.io/py/ARC-Alkali-Rydberg-Calculator) [](https://mybinder.org/v2/gh/nikolasibalic/ARC-Alkali-Rydberg-Calculator.git/master?urlpath=lab%2Ftree%2Fdoc%2FRydberg_atoms_a_primer_notebook.ipynb)
-------
Authors
-------
[Nikola Šibalić](https://github.com/nikolasibalic), [Elizabeth J. Robertson](https://www.heibrids.berlin/people/doctoral-researchers/elizabeth-robertson/), [Jonathan D. Pritchard](http://photonics.phys.strath.ac.uk/people/dr-jonathan-pritchard/), [Robert M. Potvliege](https://www.durham.ac.uk/staff/r-m-potvliege/), [Matthew P. A. Jones](https://www.durham.ac.uk/staff/m-p-a-jones/), [Charles S. Adams](https://www.durham.ac.uk/staff/c-s-adams/), [Kevin J. Weatherill](https://www.durham.ac.uk/staff/k-j-weatherill/) and [contributors](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/graphs/contributors)
**Please cite as:**
The simplest way to obtain correct reference(s), given the number of contributions,
is to **call - at the end of your Python script that uses ARC - following function**
```python
from arc import *
# use ARC
print(getCitationForARC())
```
The `getCitationForARC()` will print references that introduced methods
you used into ARC library. Otherwise, you can do manual decision making
based on the logic below:
If you use alkali atoms:
N. Šibalić, J. D. Pritchard, K. J. Weatherill, C. S. Adams,
ARC: An open-source library for calculating properties of alkali Rydberg atoms,
*Computer Physics Communications* **220**, 319 (2017), [https://doi.org/10.1016/j.cpc.2017.06.015](https://doi.org/10.1016/j.cpc.2017.06.015)
If you use divalent atoms (Sr, Ca, Yb ...) or new featutures from ARC 3.0:
E. J. Robertson, N. Šibalić, R. M. Potvliege, M. P. A. Jones,
ARC 3.0: An expanded Python toolbox for atomic physics calculations, *Computer Physics Communications* **261**, 107814 (2021) [https://doi.org/10.1016/j.cpc.2020.107814](https://doi.org/10.1016/j.cpc.2020.107814)
**In addition to main reference above**: If you are using modules from `arc.advanced` please
[paper](arc/advanced/README.md) that introduced relevant ARC extension.
If you are using modules AC Stark calculations `ShirleyMethod` or `RWAStarkShift` please **also cite** [D. H. Meyer, Z. A. Castillo, K. C. Cox, P. D. Kunz, J. Phys. B: At. Mol. Opt. Phys., 53, 034001 (2020) ](https://doi.org/10.1088/1361-6455/ab6051).
**Who are the users of this library?** Check papers that cite us in [ADS](https://ui.adsabs.harvard.edu/abs/2017CoPhC.220..319S/citations) and [Google Scholar](https://scholar.google.com/scholar?cites=3162548955488940394&as_sdt=2005&sciodt=0,5&hl=en).
-------
License
-------
All the files distributed with this program are provided subject to the
BSD-3-Clause license. A copy of the license is provided.
Raw data
{
"_id": null,
"home_page": "https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator",
"name": "ARC-Alkali-Rydberg-Calculator",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "rydberg, physics, stark maps, atom interactions, quantum optics, van der Waals, scientific, atomic sensors, quantum simulator, alkali atoms, alkaline atoms, divalent atoms, quantum computing",
"author": "Nikola Sibalic, Elizabeth J. Robertson, Jonathan D. Pritchard, Robert M. Potvliege, Matthew P. A. Jones, Charles S. Adams, Kevin J. Weatherill, and contributors",
"author_email": "nikolasibalic@physics.org",
"download_url": "https://files.pythonhosted.org/packages/35/91/ab23e869a8fbe8661e07e9728e650a6e312fc76c23367ebcddb84d8cf1dd/ARC-Alkali-Rydberg-Calculator-3.4.1.tar.gz",
"platform": null,
"description": "\nARC (Alkali.ne Rydberg Calculator)\n==================================\n\n\nARC (Alkali.ne Rydberg Calculator) is package of routines written in Python, using object-oriented programming (OOP) to make modular, reusable and extendable collection of routines and data for performing useful calculations of single atom and two-atom properties, like level diagrams, interactions and transition strengths for alkali metal and divalent atoms.\n\nStart by installing the latest version of the ARC package calling Python pip ([see prerequisites](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/installation.html)) from the command line:\n\n```pip install ARC-Alkali-Rydberg-Calculator ```\n\nFor documentation see [online documentation on Read The Docs](http://arc-alkali-rydberg-calculator.readthedocs.io). \n\nFor examples of use check [IPython example notebooks](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/getting_started.html#ipython-notebook-with-examples).\n\nFor online access to a selection of package functions see [online Atom Calculator](https://atomcalc.org).\n\nIf you want to contribute to the project, [check this page](https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/contribute.html).\n\n [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_linux.yaml) [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_windows.yaml) [](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/actions/workflows/pypi_macos.yaml) [](https://badge.fury.io/py/ARC-Alkali-Rydberg-Calculator) [](https://mybinder.org/v2/gh/nikolasibalic/ARC-Alkali-Rydberg-Calculator.git/master?urlpath=lab%2Ftree%2Fdoc%2FRydberg_atoms_a_primer_notebook.ipynb)\n\n-------\nAuthors\n-------\n\n[Nikola \u0160ibali\u0107](https://github.com/nikolasibalic), [Elizabeth J. Robertson](https://www.heibrids.berlin/people/doctoral-researchers/elizabeth-robertson/), [Jonathan D. Pritchard](http://photonics.phys.strath.ac.uk/people/dr-jonathan-pritchard/), [Robert M. Potvliege](https://www.durham.ac.uk/staff/r-m-potvliege/), [Matthew P. A. Jones](https://www.durham.ac.uk/staff/m-p-a-jones/), [Charles S. Adams](https://www.durham.ac.uk/staff/c-s-adams/), [Kevin J. Weatherill](https://www.durham.ac.uk/staff/k-j-weatherill/) and [contributors](https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/graphs/contributors)\n\n**Please cite as:** \n\nThe simplest way to obtain correct reference(s), given the number of contributions,\nis to **call - at the end of your Python script that uses ARC - following function**\n```python\nfrom arc import *\n# use ARC\nprint(getCitationForARC())\n```\nThe `getCitationForARC()` will print references that introduced methods\nyou used into ARC library. Otherwise, you can do manual decision making\nbased on the logic below:\n\nIf you use alkali atoms:\nN. \u0160ibali\u0107, J. D. Pritchard, K. J. Weatherill, C. S. Adams,\nARC: An open-source library for calculating properties of alkali Rydberg atoms,\n*Computer Physics Communications* **220**, 319 (2017), [https://doi.org/10.1016/j.cpc.2017.06.015](https://doi.org/10.1016/j.cpc.2017.06.015)\n\nIf you use divalent atoms (Sr, Ca, Yb ...) or new featutures from ARC 3.0:\nE. J. Robertson, N. \u0160ibali\u0107, R. M. Potvliege, M. P. A. Jones,\nARC 3.0: An expanded Python toolbox for atomic physics calculations, *Computer Physics Communications* **261**, 107814 (2021) [https://doi.org/10.1016/j.cpc.2020.107814](https://doi.org/10.1016/j.cpc.2020.107814)\n\n**In addition to main reference above**: If you are using modules from `arc.advanced` please\n[paper](arc/advanced/README.md) that introduced relevant ARC extension.\n\nIf you are using modules AC Stark calculations `ShirleyMethod` or `RWAStarkShift` please **also cite** [D. H. Meyer, Z. A. Castillo, K. C. Cox, P. D. Kunz, J. Phys. B: At. Mol. Opt. Phys., 53, 034001 (2020) ](https://doi.org/10.1088/1361-6455/ab6051).\n\n**Who are the users of this library?** Check papers that cite us in [ADS](https://ui.adsabs.harvard.edu/abs/2017CoPhC.220..319S/citations) and [Google Scholar](https://scholar.google.com/scholar?cites=3162548955488940394&as_sdt=2005&sciodt=0,5&hl=en).\n\n-------\nLicense\n-------\n\nAll the files distributed with this program are provided subject to the\nBSD-3-Clause license. A copy of the license is provided.\n",
"bugtrack_url": null,
"license": "BSD3",
"summary": "Alkali Rydberg Calculator",
"version": "3.4.1",
"project_urls": {
"Download": "https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator/archive/refs/tags/v3.4.1.tar.gz",
"Homepage": "https://github.com/nikolasibalic/ARC-Alkali-Rydberg-Calculator"
},
"split_keywords": [
"rydberg",
" physics",
" stark maps",
" atom interactions",
" quantum optics",
" van der waals",
" scientific",
" atomic sensors",
" quantum simulator",
" alkali atoms",
" alkaline atoms",
" divalent atoms",
" quantum computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf69f2a7af7687cecbc6e7212287e14eb0290fc6c5c99856793a6284cf7c2d21",
"md5": "7845cd9428bc3a89c0b73ef5fc182bb0",
"sha256": "07773fa2d2c89a07152a6f0b4a9270f818e903d381d7a9e8fcce530d2d58dee6"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp310-cp310-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "7845cd9428bc3a89c0b73ef5fc182bb0",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 27211433,
"upload_time": "2024-05-15T21:38:40",
"upload_time_iso_8601": "2024-05-15T21:38:40.791607Z",
"url": "https://files.pythonhosted.org/packages/cf/69/f2a7af7687cecbc6e7212287e14eb0290fc6c5c99856793a6284cf7c2d21/ARC_Alkali_Rydberg_Calculator-3.4.1-cp310-cp310-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8ac3d0ecdf6dacbbda3582f693116a2a3cd097a4b913dae41c9decfeea9bcfc",
"md5": "a01b240a1f3027f268609abc280ecf2a",
"sha256": "5e61581e8053b3e582fdfaca83f3081414503d2958bcd5f7b38d7a9214540482"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "a01b240a1f3027f268609abc280ecf2a",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 27206795,
"upload_time": "2024-05-15T21:40:25",
"upload_time_iso_8601": "2024-05-15T21:40:25.591919Z",
"url": "https://files.pythonhosted.org/packages/f8/ac/3d0ecdf6dacbbda3582f693116a2a3cd097a4b913dae41c9decfeea9bcfc/ARC_Alkali_Rydberg_Calculator-3.4.1-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cea5b47165be3105abe0452f16355e7e6c479c280aa28f3fcd3a4d5746297bf8",
"md5": "880c4cd5f2a05674b0c7107f03c15f15",
"sha256": "8c9509d5173e615be421260be0f973ccccc33984066bb4cc8c1db17dc4b5c030"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp311-cp311-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "880c4cd5f2a05674b0c7107f03c15f15",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 27211252,
"upload_time": "2024-05-15T21:38:43",
"upload_time_iso_8601": "2024-05-15T21:38:43.998394Z",
"url": "https://files.pythonhosted.org/packages/ce/a5/b47165be3105abe0452f16355e7e6c479c280aa28f3fcd3a4d5746297bf8/ARC_Alkali_Rydberg_Calculator-3.4.1-cp311-cp311-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee7b8660b89943ab6b3b18b0e0b95e7ce06d6fb22296107b7e658749155c366a",
"md5": "7150642f98467e21de12d87f32ad22c1",
"sha256": "093118270103c4db473a0f649fda903c046425706c7f9b9dafe2a3bd542efde2"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "7150642f98467e21de12d87f32ad22c1",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 27206684,
"upload_time": "2024-05-15T21:40:25",
"upload_time_iso_8601": "2024-05-15T21:40:25.993745Z",
"url": "https://files.pythonhosted.org/packages/ee/7b/8660b89943ab6b3b18b0e0b95e7ce06d6fb22296107b7e658749155c366a/ARC_Alkali_Rydberg_Calculator-3.4.1-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc624de8ea1940a875134299aba2e0c80733e058d03f2c39184e05718de0547e",
"md5": "e532af243aaaf6d3aeee0f9b1347a943",
"sha256": "64757619bac0ef9624c305caed079b4885b7bc7ef8a7ba6b1459f797cde561f8"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp312-cp312-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "e532af243aaaf6d3aeee0f9b1347a943",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 27211457,
"upload_time": "2024-05-15T21:38:56",
"upload_time_iso_8601": "2024-05-15T21:38:56.800580Z",
"url": "https://files.pythonhosted.org/packages/bc/62/4de8ea1940a875134299aba2e0c80733e058d03f2c39184e05718de0547e/ARC_Alkali_Rydberg_Calculator-3.4.1-cp312-cp312-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d19103b06567dbcdb0bcccad904d9d460f574f3625fc8c5b0075bf51e4a8a16",
"md5": "886aca2549a1888491830b3c20c0d033",
"sha256": "7278ad1cdc0007158ce57529c1d996835332025822dd920ecd2b80b46ecc94f6"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp312-cp312-win_amd64.whl",
"has_sig": false,
"md5_digest": "886aca2549a1888491830b3c20c0d033",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 27206809,
"upload_time": "2024-05-15T21:40:22",
"upload_time_iso_8601": "2024-05-15T21:40:22.626735Z",
"url": "https://files.pythonhosted.org/packages/6d/19/103b06567dbcdb0bcccad904d9d460f574f3625fc8c5b0075bf51e4a8a16/ARC_Alkali_Rydberg_Calculator-3.4.1-cp312-cp312-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49d73a189c7143a40c58ebc4369f7460aae50d23ce14954259b6efe34547fada",
"md5": "0bef727c1f1e55204940218d30e24d93",
"sha256": "c1b34bc5a1c1388506ac878dfc183cc689f5724b9d32060fe465809e1b34a421"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp38-cp38-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "0bef727c1f1e55204940218d30e24d93",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 27211367,
"upload_time": "2024-05-15T21:39:28",
"upload_time_iso_8601": "2024-05-15T21:39:28.695084Z",
"url": "https://files.pythonhosted.org/packages/49/d7/3a189c7143a40c58ebc4369f7460aae50d23ce14954259b6efe34547fada/ARC_Alkali_Rydberg_Calculator-3.4.1-cp38-cp38-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6880b190ab6a2d4ee102345074b839887aa544de54756bef37e9b1c638014108",
"md5": "2a0b2a3c46c6fd967f1cd7b731970830",
"sha256": "012fc6b766dd5e6b17fd7aa490bff8e25b079aa38f8155585f8db95f121e9342"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "2a0b2a3c46c6fd967f1cd7b731970830",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 27206905,
"upload_time": "2024-05-15T21:40:10",
"upload_time_iso_8601": "2024-05-15T21:40:10.519385Z",
"url": "https://files.pythonhosted.org/packages/68/80/b190ab6a2d4ee102345074b839887aa544de54756bef37e9b1c638014108/ARC_Alkali_Rydberg_Calculator-3.4.1-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "924480eeb7939b44c88f4defc9a5120908b8e1c0046c2b47b8e10df068abf439",
"md5": "2c3a0e81a9f66d7ab0ce128b35897602",
"sha256": "55da48bd01915647e61a254a56f01f8ac0b5c4475d617c5b5f32c003ee768099"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp39-cp39-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "2c3a0e81a9f66d7ab0ce128b35897602",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 27211437,
"upload_time": "2024-05-15T21:39:19",
"upload_time_iso_8601": "2024-05-15T21:39:19.100597Z",
"url": "https://files.pythonhosted.org/packages/92/44/80eeb7939b44c88f4defc9a5120908b8e1c0046c2b47b8e10df068abf439/ARC_Alkali_Rydberg_Calculator-3.4.1-cp39-cp39-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3afd5b8157726d05d8c2df48140742f042c01e8eb37e79085d3b3533dd44c511",
"md5": "fc05cbbf66beb0e4092aaf8bbb141ceb",
"sha256": "e1e7104f3256fdc08617d7fca7878fb4106b865a17c32b46e931e2b0f0496f44"
},
"downloads": -1,
"filename": "ARC_Alkali_Rydberg_Calculator-3.4.1-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "fc05cbbf66beb0e4092aaf8bbb141ceb",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 27207011,
"upload_time": "2024-05-15T21:40:10",
"upload_time_iso_8601": "2024-05-15T21:40:10.105243Z",
"url": "https://files.pythonhosted.org/packages/3a/fd/5b8157726d05d8c2df48140742f042c01e8eb37e79085d3b3533dd44c511/ARC_Alkali_Rydberg_Calculator-3.4.1-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3591ab23e869a8fbe8661e07e9728e650a6e312fc76c23367ebcddb84d8cf1dd",
"md5": "c6f982c4e9187f9c9f89c9ddd4b448ef",
"sha256": "dee81a906ad6159ebb4926a8339ef3179869646086f3b818bb68462c924c6c50"
},
"downloads": -1,
"filename": "ARC-Alkali-Rydberg-Calculator-3.4.1.tar.gz",
"has_sig": false,
"md5_digest": "c6f982c4e9187f9c9f89c9ddd4b448ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26492387,
"upload_time": "2024-05-15T21:38:45",
"upload_time_iso_8601": "2024-05-15T21:38:45.209386Z",
"url": "https://files.pythonhosted.org/packages/35/91/ab23e869a8fbe8661e07e9728e650a6e312fc76c23367ebcddb84d8cf1dd/ARC-Alkali-Rydberg-Calculator-3.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 21:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nikolasibalic",
"github_project": "ARC-Alkali-Rydberg-Calculator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "arc-alkali-rydberg-calculator"
}
JSON
