Metadata-Version: 2.4
Name: qoolqit
Version: 1.0.0
Summary: A Python library for developing algorithms in the Rydberg Analog Model.
Project-URL: Documentation, https://pasqal-io.github.io/qoolqit/latest
Project-URL: Issues, https://github.com/pasqal-io/qoolqit/issues
Project-URL: Source, https://github.com/pasqal-io/qoolqit
Author-email: João Moutinho <joao.moutinho@pasqal.com>, Stefano Grava <s.grava-ext@pasqal.com>, Vytautas Abramavicius <vytautas.abramavicius@pasqal.com>, Roland Guichard <roland.guichard@pasqal.com>, David Teller <david.teller@pasqal.com>, Manu Lahariya <manu.lahariya@pasqal.com>, Charles MOUSSA <charles.moussa@pasqal.com>, Vittorio Vitale <vittorio.vitale@pasqal.com>, Clément de Terrasson de Montleau <clement.de-terrasson@pasqal.com>, Mathieu Garrigues <mathieu.garrigues@pasqal.com>
License: MIT-derived
License-File: LICENSE
Keywords: quantum
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: networkx>=3.4
Requires-Dist: pulser[torch]>=1.7.0
Provides-Extra: dev
Requires-Dist: emu-mps; extra == 'dev'
Requires-Dist: emu-sv; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: jupyter; extra == 'dev'
Requires-Dist: markdown-exec; extra == 'dev'
Requires-Dist: mike; extra == 'dev'
Requires-Dist: mkdocs; extra == 'dev'
Requires-Dist: mkdocs-jupyter; extra == 'dev'
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocs-section-index; extra == 'dev'
Requires-Dist: mkdocstrings-python; extra == 'dev'
Requires-Dist: nbmake; extra == 'dev'
Requires-Dist: pandas; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-markdown-docs; extra == 'dev'
Requires-Dist: scikit-learn; extra == 'dev'
Requires-Dist: seaborn; extra == 'dev'
Requires-Dist: torch-geometric; extra == 'dev'
Provides-Extra: extras
Requires-Dist: emu-mps; extra == 'extras'
Requires-Dist: emu-sv; extra == 'extras'
Requires-Dist: pandas; extra == 'extras'
Requires-Dist: scikit-learn; extra == 'extras'
Requires-Dist: seaborn; extra == 'extras'
Requires-Dist: torch-geometric; extra == 'extras'
Description-Content-Type: text/markdown


<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="./docs/extras/assets/logo/qoolqit_logo_white.svg" width="60%">
    <source media="(prefers-color-scheme: light)" srcset="./docs/extras/assets/logo/qoolqit_logo_darkgreen.svg" width="60%">
    <img alt="Qoolqit logo" src="./docs/assets/logo/qoolqit_logo_darkgreen.svg" width="60%">
  </picture>
</p>

<p align="center">
  <strong>QoolQit</strong> is a Python library for algorithm development in the Rydberg Analog Model.
</p>

**For more detailed information, [check out the documentation](https://pasqal-io.github.io/qoolqit/latest/)**.

## Install from PyPi
QoolQit can be installed from PyPi with your favorite pyproject-compatible Python manager.
On `pip`, for example:

```sh
pip install qoolqit
```

## Add QoolQit as a dependency
For usage within a project with a corresponding `pyproject.toml` file, you can add
`qoolqit` to the list of dependencies as follows:

```toml
[project]
dependencies = [
  "qoolqit"
]
```

## Install from source
If you wish to install directly from the source, for example, if you are developing code for QoolQit, you can:

1) Clone the [QoolQit GitHub repository](https://github.com/pasqal-io/qoolqit)

  ```sh
  git clone https://github.com/pasqal-io/qoolqit.git
  ```

2) Setup an environment for developing. From your `qoolqit` folder, again install with your favorite environment/package managers.
  On `venv`/`pip`, for example:

  ```sh
  python -m venv .venv
  source .venv/bin/activate
  pip install -e .[dev]
  ```


# Getting in touch

- [Pasqal Community Portal](https://community.pasqal.com/) (forums, chat, tutorials, examples, code library).
- [GitHub Repository](https://github.com/pasqal-io/qoolqit/) (source code, issue tracker).
- [Professional Support](https://www.pasqal.com/contact-us/) (if you need tech support, custom licenses, a variant of this library optimized for your workload, your own QPU, remote access to a QPU, ...)
