[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# django-qlued
A django package the couples together quantum hardware and endusers. It allows cold atom hardware and simulators to be accessed through the `qiskit-cold-atom` and the `sqooler` SDK:
- `qlued` handles the user management and stores the received *json* file in an appropiate queue.
- `qiskit-cold-atom` allows the enduser to write the circuit definitions on its laptop and send them to the server in form of a nice *json* file.
- `sqooler` acts as the SDK that pulls the the calculations from the queue and sends back the result into the storage.
- end devices like the [sqooler-example](https://github.com/Alqor-UG/sqooler-example) or the [labscript-qc-example](https://github.com/Alqor-UG/labscript-qc-example) can perform the calculation and display it to the user.
## Getting started
You can currently install the package via pip through:
```
pip install django-qlued
```
We provide a template for a simple startup:
- The fully deployable example is accessible via [qlued](https://github.com/Alqor-UG/qlued).
- Examples for configurations can be found in the `tests` folder.
## Contributing
See [the contributing guide](docs/contributing.md) for detailed instructions on how to get started with a contribution to our project. We accept different **types of contributions**, most of them don't require you to write a single line of code.
On the [qlued](https://alqor-ug.github.io/django-qlued/) site, you can click the make a contribution button at the top of the page to open a pull request for quick fixes like typos, updates, or link fixes.
For more complex contributions, you can [open an issue](https://github.com/alqor-ug/django-qlued/issues) to describe the changes you'd like to see.
If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/alqor-ug/django-qlued/issues) for something to work on.
### Join us in discussions
We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/alqor-ug/django-qlued/discussions).
## License
Any code within this repo is licenced under the [Apache 2](LICENSE) licence.
The qlued documentation in the docs folders are licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).
## Thanks :purple_heart:
Thanks for all your contributions and efforts towards improving qlued. We thank you for being part of our :sparkles: community :sparkles:!
Raw data
{
"_id": null,
"home_page": "https://github.com/Alqor-UG/django-qlued",
"name": "django-qlued",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "pydantic, quantum-hardware, django, django-ninja",
"author": "fretchen",
"author_email": "fred.jendrzejewski@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c3/9b/a9629ce5f42cef81edce3201d810d4c9c14285ce657637811b6f90948c16/django_qlued-0.3.0.tar.gz",
"platform": null,
"description": "[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n# django-qlued\n\nA django package the couples together quantum hardware and endusers. It allows cold atom hardware and simulators to be accessed through the `qiskit-cold-atom` and the `sqooler` SDK:\n\n- `qlued` handles the user management and stores the received *json* file in an appropiate queue.\n- `qiskit-cold-atom` allows the enduser to write the circuit definitions on its laptop and send them to the server in form of a nice *json* file.\n- `sqooler` acts as the SDK that pulls the the calculations from the queue and sends back the result into the storage.\n- end devices like the [sqooler-example](https://github.com/Alqor-UG/sqooler-example) or the [labscript-qc-example](https://github.com/Alqor-UG/labscript-qc-example) can perform the calculation and display it to the user.\n\n## Getting started\n\nYou can currently install the package via pip through:\n\n```\npip install django-qlued\n```\n\nWe provide a template for a simple startup:\n\n- The fully deployable example is accessible via [qlued](https://github.com/Alqor-UG/qlued).\n- Examples for configurations can be found in the `tests` folder.\n\n## Contributing\n\nSee [the contributing guide](docs/contributing.md) for detailed instructions on how to get started with a contribution to our project. We accept different **types of contributions**, most of them don't require you to write a single line of code.\n\nOn the [qlued](https://alqor-ug.github.io/django-qlued/) site, you can click the make a contribution button at the top of the page to open a pull request for quick fixes like typos, updates, or link fixes.\n\nFor more complex contributions, you can [open an issue](https://github.com/alqor-ug/django-qlued/issues) to describe the changes you'd like to see.\n\nIf you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/alqor-ug/django-qlued/issues) for something to work on. \n\n### Join us in discussions\n\nWe use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/alqor-ug/django-qlued/discussions).\n\n## License\n\nAny code within this repo is licenced under the [Apache 2](LICENSE) licence.\n\nThe qlued documentation in the docs folders are licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).\n\n\n## Thanks :purple_heart:\n\nThanks for all your contributions and efforts towards improving qlued. We thank you for being part of our :sparkles: community :sparkles:!",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Django packages that enables validated cloud access to quantum hardware.",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://alqor-ug.github.io/django-qlued",
"Homepage": "https://github.com/Alqor-UG/django-qlued",
"Repository": "https://github.com/Alqor-UG/django-qlued"
},
"split_keywords": [
"pydantic",
" quantum-hardware",
" django",
" django-ninja"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b5e1a08e770444f9e295df11e648df5732cff5c09901d9ef576dcb1d9f0338",
"md5": "31bfddc24eda71c707574826c66d7c7b",
"sha256": "52211fd31cd40db8574459426078d5f6510cefb446279ca992e1f09fa54d94c8"
},
"downloads": -1,
"filename": "django_qlued-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31bfddc24eda71c707574826c66d7c7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 15487,
"upload_time": "2024-06-29T11:11:03",
"upload_time_iso_8601": "2024-06-29T11:11:03.185020Z",
"url": "https://files.pythonhosted.org/packages/a2/b5/e1a08e770444f9e295df11e648df5732cff5c09901d9ef576dcb1d9f0338/django_qlued-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c39ba9629ce5f42cef81edce3201d810d4c9c14285ce657637811b6f90948c16",
"md5": "d4729dcaf7c20c7126b41dc9fc96d9b3",
"sha256": "1ad370559201f433bd2aa603ab739685254fb8d51a859dca7dc8093c27d156c7"
},
"downloads": -1,
"filename": "django_qlued-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "d4729dcaf7c20c7126b41dc9fc96d9b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 14062,
"upload_time": "2024-06-29T11:11:04",
"upload_time_iso_8601": "2024-06-29T11:11:04.422357Z",
"url": "https://files.pythonhosted.org/packages/c3/9b/a9629ce5f42cef81edce3201d810d4c9c14285ce657637811b6f90948c16/django_qlued-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-29 11:11:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alqor-UG",
"github_project": "django-qlued",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-qlued"
}