{"id":13751423,"url":"https://github.com/qiskit-community/qiskit-cold-atom","last_synced_at":"2025-04-21T08:32:36.365Z","repository":{"id":39802473,"uuid":"409477700","full_name":"qiskit-community/qiskit-cold-atom","owner":"qiskit-community","description":"Tools to control cold-atom-based quantum simulators and quantum computers.","archived":false,"fork":false,"pushed_at":"2024-03-28T20:24:43.000Z","size":12701,"stargazers_count":31,"open_issues_count":11,"forks_count":18,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-18T12:55:33.676Z","etag":null,"topics":["provider"],"latest_commit_sha":null,"homepage":"https://qiskit-community.github.io/qiskit-cold-atom/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qiskit-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2021-09-23T06:40:14.000Z","updated_at":"2024-09-26T00:58:23.000Z","dependencies_parsed_at":"2023-12-18T23:12:06.519Z","dependency_job_id":"da8ea688-5829-4538-83e7-368797dda405","html_url":"https://github.com/qiskit-community/qiskit-cold-atom","commit_stats":null,"previous_names":["qiskit-extensions/qiskit-cold-atom"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-cold-atom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-cold-atom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-cold-atom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiskit-community%2Fqiskit-cold-atom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qiskit-community","download_url":"https://codeload.github.com/qiskit-community/qiskit-cold-atom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250023595,"owners_count":21362433,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["provider"],"created_at":"2024-08-03T09:00:44.630Z","updated_at":"2025-04-21T08:32:35.565Z","avatar_url":"https://github.com/qiskit-community.png","language":"Python","funding_links":[],"categories":["Community"],"sub_categories":[],"readme":"# Qiskit Cold Atom \n\n\u003cimg src=\"docs/images/qiskit_cold_atom_logo_with_text.svg\" alt=\"Qiskit cold atom logo\" style=\"height: 228px; width:450px;\"/\u003e\n\n**Qiskit** is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.\n\nThis project builds on this functionality to describe programmable quantum simulators of trapped cold atoms \nin a gate- and circuit-based framework. This includes a provider that allows access to cold atomic\nquantum devices located at Heidelberg University.\n\nTraditionally, each wire in a quantum circuit represents one qubit as the fundamental unit of information processing. \nHere, we extend this concept and allow wires to represent individual internal states of trapped cold atoms. \nThis currently covers two settings, one for fermionic modes and one for spin modes, \ndemonstrating that a broad range of hardware can be accommodated in Qiskit.\n\nWe encourage new users to familiarize themselves with the basic functionalities through the tutorial-style python notebooks in [`docs/tutorials`](docs/tutorials). \nThese require an environment to execute `.ipynb` notebooks such as jupyter lab. \n\n## Installation\n\nTo install Qiskit Cold Atom from source and further develop the package, clone this repository and install from the project root using pip:\n```bash\npip install -e .\n```\nTo use the repository you can also install using either\n```bash\npip install git+https://github.com/qiskit-community/qiskit-cold-atom.git\n```\nor Pypi\n```bash\npip install qiskit-cold-atom\n```\nTo install Qiskit Cold Atom with the [ffsim fermion simulator backend](#cold-atomic-circuits) (not supported on Windows), specify the `ffsim` extra in the `pip` install command, e.g.\n```bash\npip install \"qiskit-cold-atom[ffsim]\"\n```\n\n## Setting up the Cold Atom Provider \nQiskit Cold Atom includes local simulator backends to explore the cold atomic hardware. In order to access\nremote device backends, you will need valid user credentials. \nTo this end, the user has to specify the `url` of the desired backend and a valid `username` and `token` as a password, \nwhich can be saved as an account: \n\n```python\nfrom qiskit_cold_atom.providers import ColdAtomProvider\n\n# save an account to disk\nColdAtomProvider.save_account(urls = [\"url_backend_1\", \"url_backend_2\"], username=\"my_name\", token=\"my_password\") \n```\n\nLoading the account instantiates the provider from which the included backends can be accessed. \n\n```python\n# load the stored account\nprovider = ColdAtomProvider.load_account()\n\n# get available backends\nprint(provider.backends())\n\n# Example: Get a simulator backend\nspin_simulator_backend = provider.get_backend(\"collective_spin_simulator\")\n```\n\n## Cold atomic circuits\n\nThe circuits that can be run on the cold atomic hardware explored in this project use different gates\nfrom the circuits typically employed in Qiskit, because these hardware are not built from qubits,\nbut from fermions or spins.\nQiskit Cold Atom includes basic simulators for both the fermion and spin settings that can be used\nto simulate small circuits. See [Introduction \u0026 Fermionic Circuits](docs/tutorials/01_introduction_and_fermionic_circuits.ipynb)\nand [Spin circuits](docs/tutorials/02_spin_circuits.ipynb) for tutorials on how to define and run gates through\nquantum circuits in these settings.\n\nQiskit Cold Atom also includes a high-performance simulator for fermionic circuits based on\n[ffsim](https://github.com/qiskit-community/ffsim), which can handle much larger circuits than the basic simulator mentioned before. The ffsim simulator is not supported on Windows, and in order\nfor it to be available, Qiskit Cold Atom must be installed with the `ffsim` extra, e.g.\n```bash\npip install \"qiskit-cold-atom[ffsim]\"\n```\n\n## Documentation\n\nThe documentation can be found as Github pages here [https://qiskit-community.github.io/qiskit-cold-atom/](https://qiskit-community.github.io/qiskit-cold-atom/).\nTo build the API reference locally, run:\n\n```bash\npip install -r requirements-dev.txt\nmake -C docs html\nopen docs/_build/html/index.html\n```\n\n## Tests\nTest are located in the `test` folder. All contributions should come with test files that are named `test_*.py` which test the new functionalities. \nTo execute the test suite locally, run\n```bash\npython -m unittest\n```\nfrom the project root. \n\n## License\n\n[Apache License 2.0].\n\n[Apache License 2.0]: https://github.com/qiskit-community/qiskit-cold-atom/blob/master/LICENSE.txt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiskit-community%2Fqiskit-cold-atom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqiskit-community%2Fqiskit-cold-atom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiskit-community%2Fqiskit-cold-atom/lists"}