{"id":13751398,"url":"https://github.com/C2QA/bosonic-qiskit","last_synced_at":"2025-05-09T18:31:26.890Z","repository":{"id":37855849,"uuid":"306339692","full_name":"C2QA/bosonic-qiskit","owner":"C2QA","description":"Extension of Qiskit to support hybrid boson-qubit simulations for the NQI C2QA effort.","archived":false,"fork":false,"pushed_at":"2024-11-13T16:58:12.000Z","size":30078,"stargazers_count":49,"open_issues_count":6,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-13T17:34:22.866Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/C2QA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2020-10-22T13:05:08.000Z","updated_at":"2024-11-10T18:25:31.000Z","dependencies_parsed_at":"2023-10-14T22:22:18.445Z","dependency_job_id":"3a55451d-cee3-4794-92c3-f9d6d71cfbe7","html_url":"https://github.com/C2QA/bosonic-qiskit","commit_stats":{"total_commits":585,"total_committers":11,"mean_commits":53.18181818181818,"dds":0.4717948717948718,"last_synced_commit":"27239cbc871a96ade4da1da262964ea3d1da798c"},"previous_names":["c2qa/c2qa-qiskit"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/C2QA%2Fbosonic-qiskit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/C2QA%2Fbosonic-qiskit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/C2QA%2Fbosonic-qiskit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/C2QA%2Fbosonic-qiskit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/C2QA","download_url":"https://codeload.github.com/C2QA/bosonic-qiskit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224876983,"owners_count":17384699,"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":[],"created_at":"2024-08-03T09:00:43.856Z","updated_at":"2025-05-09T18:31:26.857Z","avatar_url":"https://github.com/C2QA.png","language":"Jupyter Notebook","funding_links":[],"categories":["Community","Quantum full-stack libraries"],"sub_categories":[],"readme":"# Bosonic Qiskit\n\nNQI C2QA project to simulate hybrid boson-qubit systems within QisKit.\n\n## Installation\n\nBosonic-qiskit can be installed from PyPI:\n\n```bash\npip install bosonic-qiskit\n```\n\nWe recommend the use of a virtual environment.\n\n### Development\n\nFirst, checkout the code from Github and use the provided script to create a virtual environment with the necessary dependencies:\n\n```bash\ngit clone https://github.com/C2QA/bosonic-qiskit.git\ncd bosonic-qiskit\n./install-dependencies.sh\n```\n\nThen, install development dependencies and bosonic-qiskit in editable mode (after activating the newly-created virtual environment)\n\n```bash\nsource venv/bin/activate\npip install -r requirements_dev.txt\npip install -e .\n```\n\n### Dependency Version Compatibility\n\nThe Bosonic Qiskit software has not been extensively tested with different versions of its [dependencies](requirements.txt); however, some success has been achieved with both newer and older versions of Qiskit. Do note that some features require newer versions. For example, the noise modelling requires Qiskit v0.34.2+. Using older versions will cause `ModuleNotFoundError` at runtime.\n\n## Tutorials\n\nJupyter Notebook tutorials can be found in the [tutorials](tutorials) folder. JupyterLab is a dependency found in [requirements.txt](requirements.txt), so after installing and activating the virtual environment, to run the tutorials simply start Jupyter with `jupyter lab` and then navigate to the desired tutorial.\n\nSee our paper presented at IEEE HPEC 2022 on [arXiv](https://arxiv.org/abs/2209.11153) for more information on using bosonic-qiskit.\n\n## How to add gates\n\nThe code is structured to separate generation of the operator matrices from creating instances of QisKit Gate. \n\nThe first step in adding a new gate is to develop software to build a unitary operator matrix. These matrices must be unitary in order for QisKit to simulate them. Non unitary matrices will fail during simulation. Existing operator matrices are built in the CVOperators class found in [operators.py](c2qa/operators.py). Included in CVOperators are functions to build the bosonic creation and annihilation operators based on a provided cutoff. The order of the data in your operators must match the order of the qumodes (QisKit qubits) sent in as QisKit gate parameters found in [circuit.py](c2qa/circuit.py), as described next.\n\nOnce you've written software to build the operator matrix, a new function is added to the CVCircuit class found in [circuit.py](c2qa/circuit.py). This class extends the QisKit QuantumCircuit class to add the bosonic gates available in this library. The previusly defined operators are parameterized by user input, as needed, and appended to the QuantumCircuit as unitary gates. The CVCircuit class includes functions to easily make your new gates conditional based on a control qubit.\n\nSee examples of software building new gates in the previously mentioned [operators.py](c2qa/operators.py) and [circuit.py](c2qa/circuit.py). Examples using the library's gates can be found in both the PyTest [test cases](tests) and Jupyter Notebook [tutorials](tutorials) folders\n\n## Available Gates\n\nCurrent gates available for simulation are documented at https://c2qa.github.io/bosonic-qiskit/c2qa.circuit.CVCircuit.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FC2QA%2Fbosonic-qiskit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FC2QA%2Fbosonic-qiskit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FC2QA%2Fbosonic-qiskit/lists"}