{"id":37083843,"url":"https://github.com/pairinteraction/rydstate","last_synced_at":"2026-02-05T11:09:59.109Z","repository":{"id":323018131,"uuid":"1091785855","full_name":"pairinteraction/rydstate","owner":"pairinteraction","description":"A Rydberg State Calculator","archived":false,"fork":false,"pushed_at":"2026-01-28T16:34:30.000Z","size":13499,"stargazers_count":0,"open_issues_count":13,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-29T06:18:59.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pairinteraction.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-07T14:14:19.000Z","updated_at":"2026-01-28T16:34:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pairinteraction/rydstate","commit_stats":null,"previous_names":["pairinteraction/rydstate"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/pairinteraction/rydstate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pairinteraction%2Frydstate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pairinteraction%2Frydstate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pairinteraction%2Frydstate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pairinteraction%2Frydstate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pairinteraction","download_url":"https://codeload.github.com/pairinteraction/rydstate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pairinteraction%2Frydstate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29120484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T10:47:47.471Z","status":"ssl_error","status_checked_at":"2026-02-05T10:45:08.119Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-14T10:14:21.109Z","updated_at":"2026-02-05T11:09:59.088Z","avatar_url":"https://github.com/pairinteraction.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RydState - A Rydberg State Calculator\n\n[![PyPI Package][pypi-svg]][pypi-link]\n[![License: LGPL v3][license-lgpl-svg]][license-lgpl-link]\n[![CI Workflow][gh-workflow-svg]][gh-workflow-link]\n[![Documentation][docs-svg]][docs-link]\n\n[pypi-svg]: https://img.shields.io/pypi/v/rydstate.svg?style=flat\n[pypi-link]: https://pypi.org/project/rydstate/\n[license-lgpl-svg]: https://img.shields.io/badge/License-LGPL_v3-blue.svg?style=flat\n[license-lgpl-link]: https://www.gnu.org/licenses/lgpl-3.0.html\n[gh-workflow-svg]: https://github.com/pairinteraction/rydstate/actions/workflows/python_wheel.yml/badge.svg\n[gh-workflow-link]: https://github.com/pairinteraction/rydstate/actions/workflows/python_wheel.yml\n[docs-svg]: https://img.shields.io/badge/Documentation-rydstate-blue.svg?style=flat\n[docs-link]: https://www.pairinteraction.org/rydstate/sphinx/html/\n\nThe *RydState* software calculates properties of Rydberg states.\nWe especially focus on the calculation of the radial wavefunction of Rydberg states via the Numerov method.\nThe software can be installed via pip (requires Python \u003e= 3.9):\n\n```bash\npip install rydstate\n```\n\nTo install the latest development version from github, use:\n\n```bash\npip install git+https://github.com/pairinteraction/rydstate\n```\n\n\n## How to Cite\n\nThis package relies on quantum defects provided by the community. Consider citing relevant publications for your atomic species.\n\n\u003cp\u003e\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eClick to expand for quantum defect references\u003c/b\u003e\u003c/summary\u003e\n\n| Element | Model                 | Identifier     | References                                                                                                                                                   |\n|---------|-----------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| H       | SQDT                  | `H`            | Schrödinger equation for hydrogen                                                                                                                            |\n| Li      | SQDT                  | `Li`           | [10.1017/CBO9780511524530] (1994)\u003cbr\u003e[10.1103/PhysRevA.34.2889] (1986)                                                                                       |\n| Na      | SQDT                  | `Na`           | [10.1088/0953-4075/30/10/009] (1997)\u003cbr\u003e[10.1070/QE1995v025n09ABEH000501] (1995)\u003cbr\u003e[10.1103/PhysRevA.45.4720] (1992)                                        |\n| K       | SQDT                  | `K`            | [10.1088/0031-8949/27/4/012] (1983)\u003cbr\u003e[10.1016/0030-4018(81)90225-X] (1981)                                                                                 |\n| Rb      | SQDT                  | `Rb`           | [10.1103/PhysRevA.83.052515] (2011)\u003cbr\u003e[10.1103/PhysRevA.74.054502] (2006)\u003cbr\u003e[10.1103/PhysRevA.74.062712] (2006)\u003cbr\u003e[10.1103/PhysRevA.67.052502] (2003)     |\n| Cs      | SQDT                  | `Cs`           | [10.1103/PhysRevA.93.013424] (2016)\u003cbr\u003e[10.1103/PhysRevA.35.4650] (1987)\u003cbr\u003e[10.1103/PhysRevA.26.2733] (1982)                                                |\n| Sr88    | SQDT, singlet sector  | `Sr88` | [10.1103/PhysRevA.108.022815] (2023)\u003cbr\u003e[10.17169/refubium-34581] (2022)                                                                                     |\n| Sr88    | SQDT, triplet sector  | `Sr88` | [10.1016/j.cpc.2020.107814] (2021)                                                                                                                           |\n\u003c/details\u003e\u003c/p\u003e\n\n[10.1103/PhysRevA.34.2889]: https://doi.org/10.1103/PhysRevA.34.2889\n[10.1017/CBO9780511524530]: https://doi.org/10.1017/CBO9780511524530\n[10.1103/PhysRevA.45.4720]: https://doi.org/10.1103/PhysRevA.45.4720\n[10.1070/QE1995v025n09ABEH000501]: https://doi.org/10.1070/QE1995v025n09ABEH000501\n[10.1088/0953-4075/30/10/009]: https://doi.org/10.1088/0953-4075/30/10/009\n[10.1088/0031-8949/27/4/012]: https://doi.org/10.1088/0031-8949/27/4/012\n[10.1016/0030-4018(81)90225-X]: https://doi.org/10.1016/0030-4018(81)90225-X\n[10.1103/PhysRevA.83.052515]: https://doi.org/10.1103/PhysRevA.83.052515\n[10.1103/PhysRevA.67.052502]: https://doi.org/10.1103/PhysRevA.67.052502\n[10.1103/PhysRevA.74.054502]: https://doi.org/10.1103/PhysRevA.74.054502\n[10.1103/PhysRevA.74.062712]: https://doi.org/10.1103/PhysRevA.74.062712\n[10.1103/PhysRevA.93.013424]: https://doi.org/10.1103/PhysRevA.93.013424\n[10.1103/PhysRevA.26.2733]: https://doi.org/10.1103/PhysRevA.26.2733\n[10.1103/PhysRevA.35.4650]: https://doi.org/10.1103/PhysRevA.35.4650\n[10.1103/PhysRevA.108.022815]: https://doi.org/10.1103/PhysRevA.108.022815\n[10.17169/refubium-34581]: https://doi.org/10.17169/refubium-34581\n[10.1016/j.cpc.2020.107814]: https://doi.org/10.1016/j.cpc.2020.107814\n\n\n## Documentation\n\n**User Guide**\n\n- [Tutorials] - Examples of how to use the RydState library.\n\n- [API Reference] - Documentation of classes and functions of the RydState Python library.\n\n\n[Tutorials]: https://www.pairinteraction.org/rydstate/sphinx/html/examples.html\n[API Reference]: https://www.pairinteraction.org/rydstate/sphinx/html/modules.html\n\n\n## Using custom quantum defects\nTo use custom quantum defects (or quantum defects for a new species), you can simply create a subclass of `rydstate.species.species_object.SpeciesObject` (e.g. `class CustomRubidium(SpeciesObject):`) with a custom species name (e.g. `name = \"Custom_Rb\"`).\nThen, similarly to `rydstate.species.rubidium.py` you can define the quantum defects (and model potential parameters, ...) for your species.\nFinally, you can use the custom species by simply calling `rydstate.RydbergStateAlkali(\"Custom_Rb\", n=50, l=0, j=1/2, m=1/2)` (the code will look for all subclasses of `SpeciesObject` until it finds one with the species name \"Custom_Rb\").\n\n\n## License\n\nThe rydstate software is licensed under [LGPL v3][license-lgpl-link]. For more information, see [LICENSE.txt](https://github.com/pairinteraction/rydstate/blob/main/LICENSE.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpairinteraction%2Frydstate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpairinteraction%2Frydstate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpairinteraction%2Frydstate/lists"}