haiqu-sdk 1.0.5__tar.gz

haiqu_sdk-1.0.5/LICENSE

@@ -0,0 +1,200 @@
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-2026 Haiqu, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

haiqu_sdk-1.0.5/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: haiqu-sdk
+Version: 1.0.5
+Summary: Python SDK for Haiqu quantum cloud — circuit analytics, error mitigation, and hybrid quantum application execution
+Author-email: "Haiqu, Inc." <info@haiqu.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://haiqu.ai
+Project-URL: Documentation, https://docs.haiqu.ai
+Project-URL: Source, https://github.com/haiqu-ai/haiqu-sdk
+Project-URL: Bug Tracker, https://github.com/haiqu-ai/haiqu-sdk/-/issues
+Keywords: quantum computing,error mitigation,zero-noise extrapolation,hybrid quantum-classical,quantum applications,quantum machine learning,QML,data loading,qiskit,circuit analytics,quantum cloud
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: pydantic<3.0,>=2.6.0
+Requires-Dist: requests<3,>=2.33.0
+Requires-Dist: qiskit==2.2.*
+Requires-Dist: qiskit_ibm_runtime==0.45.*
+Requires-Dist: qiskit-aer==0.17.*
+Requires-Dist: qiskit_algorithms==0.4.0
+Requires-Dist: qiskit-addon-obp==0.3.0
+Requires-Dist: qiskit-addon-utils==0.3.0
+Requires-Dist: qiskit-qasm3-import==0.6.0
+Requires-Dist: qiskit-optimization[cplex]==0.7.0
+Requires-Dist: cplex
+Requires-Dist: hashable-list==0.2.*
+Requires-Dist: ordered-set==4.1.*
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: plotly==6.0.0
+Requires-Dist: kaleido==0.2.1
+Requires-Dist: pandas==2.3.1
+Requires-Dist: ipywidgets==8.1.8
+Provides-Extra: visualization
+Requires-Dist: matplotlib==3.9.0; extra == "visualization"
+Requires-Dist: pylatexenc==2.10; extra == "visualization"
+Provides-Extra: skqd
+Requires-Dist: ffsim; extra == "skqd"
+Provides-Extra: dev
+Requires-Dist: black==23.7.0; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: flake8==6.0.0; extra == "dev"
+Provides-Extra: build
+Dynamic: license-file
+
+# Haiqu SDK: Quantum Performance Middleware for Python
+
+Haiqu is a middleware platform that bridges the gap between quantum hardware and practical applications. Haiqu SDK gives you programmatic access to the full Haiqu cloud stack: **error mitigation**, **circuit compression**, **hardware integration**, and **experiment tracking** - so you can run quantum circuits that actually work on today's noisy hardware.
+
+![Haiqu Stack](https://raw.githubusercontent.com/haiqu-ai/haiqu-sdk/main/images/image.webp)
+
+📖 **Full documentation**: [docs.haiqu.ai](https://docs.haiqu.ai/)
+
+## What You Can Do with Haiqu
+
+- **Error Shield:** automatic noise reduction preserves circuit fidelity without manual calibration
+- **Circuit Compression:** run circuits that would otherwise exceed hardware qubit and gate limits
+- **Data Loading:** linear-depth quantum data loading at practical scale
+- **Hardware Integration:** connect to major quantum processors and cloud platforms through a single API
+- **Experiment Tracking:** monitor job history, circuit measurements, and results across runs
+
+For example, using Haiqu SDK for a utility-scale Floquet dynamics simulation of the kicked Ising model on 103 qubits reduces quantum processor runtime from **~3.1 hours** to **~1 minute**, and lowers the estimated quantum cloud bill from **~$17,856** to **~$34**, while preserving accuracy close to the ideal result.
+
+![Kicked Ising Pareto Plot](https://raw.githubusercontent.com/haiqu-ai/haiqu-sdk/main/images/pareto.png)
+
+Want to see this in action? **[Book a demo](https://haiqu.ai/demoform)** to get access to this example and more.
+
+### Research results
+
+Haiqu's technology is backed by peer-reviewed research:
+
+- [Matrix Product States for shallow quantum circuit synthesis](https://arxiv.org/abs/2412.05202)
+- [Hamiltonian simulation via sub-block partitioning and state reconstruction](https://arxiv.org/abs/2412.15804)
+- [Rivet transpiler: caching and reuse for iterative quantum workloads](https://arxiv.org/abs/2508.21342)
+- [Fluid dynamics simulation without increasing circuit complexity](https://arxiv.org/abs/2510.17978)
+- [Large Hamiltonian evolution across multiple quantum processors](https://arxiv.org/abs/2502.03542)
+
+See also the [Haiqu Blog](https://blog.haiqu.ai/) for more exciting research from us.
+## Installation
+
+This repository contains the source code for the Haiqu SDK Python package. For users, It is recommended to install it from PyPI via `pip install haiqu-sdk` rather than to build from source. Refer to [Haiqu SDK Docs / Local Installation](https://docs.haiqu.ai/quickstart/qs_local) guide for more details. 
+
+> [!TIP]
+> Alternatively, you can request access to **Haiqu Lab**: a pre-built, hosted JupyterLab environment with everything
+> pre-installed and no local setup required. This can be done through your Haiqu account after sign-up.
+
+**Prerequisites** 
+- Python **3.10+** or Conda
+
+### Step 1: Set up a Python environment (recommended)
+
+Creating a virtual environment is optional, but highly recommended to avoid system-wide install and update of package dependencies. 
+
+**Venv** (available by default with Python)
+
+```bash
+python -m venv haiqu-env
+source haiqu-env/bin/activate
+```
+*Note:* on Windows systems, instead of the shell command on the last line above, run `.\haiqu-env\Scripts\activate.bat` to activate the environment.
+
+---
+
+**Conda**
+
+```bash
+conda create -y --name haiqu-sdk python=3.13
+conda activate haiqu-sdk
+```
+
+---
+
+**Virtualenv**
+
+```bash
+virtualenv haiqu-env --python ">=3.10"
+source haiqu-env/bin/activate
+```
+
+### Step 2: Install the SDK
+
+The latest version is available from PyPI
+```bash
+pip install haiqu-sdk
+```
+
+## Getting Access
+
+To use the Haiqu SDK you need an API key.
+
+**Request access here → [haiqu.ai](https://docs.haiqu.ai/quickstart/qs_intro)**
+
+After sign-up, your API key and access instructions will be delivered by email.
+
+Once you have a key, authenticate in your code:
+
+```python
+from haiqu.sdk import haiqu
+  
+# Login with your API key
+haiqu.login(api_access_key="ENTER_YOUR_API_KEY_HERE")  # or set the HAIQU_API_KEY env variable
+  
+# Initialize your first experiment
+haiqu.init("My First Quantum Experiment")
+```
+
+On success you will see:
+
+```
+Success: Welcome to the Quantum World, you@example.com!
+```
+
+You're all set. Refer to the [Getting Started](#getting-started) section to learn what you can do with Haiqu SDK.
+
+## Getting Started
+
+SDK example notebooks are coming soon — we will be releasing the **[sdk-examples](https://github.com/haiqu-ai/sdk-examples) repository** shortly. It will act as a tutorial for basic Haiqu SDK features with ready-to-run notebooks.
+
+In the meantime, see the [Core Features](https://docs.haiqu.ai/core_features/exp_tracking) section of the Haiqu SDK docs for guides, as well as the full [Haiqu SDK Reference](https://docs.haiqu.ai/reference/core/login).
+
+## AI-Assisted Development (MCP)
+
+Haiqu exposes MCP (Model Context Protocol) servers so you can use AI assistants like Claude or Cursor to execute circuits, query results, and browse documentation directly from your editor.
+
+See [MCP.md](/MCP.md) for configuration instructions for VS Code + Claude Code and Cursor.
+
+## Feedback and Support
+
+- **Documentation:** [docs.haiqu.ai](https://docs.haiqu.ai/)
+- **Email:** [info@haiqu.ai](mailto:info@haiqu.ai)
+- **Issues and feature requests:** open an issue in this repository or visit [feedback.haiqu.ai](https://feedback.haiqu.ai/)

haiqu_sdk-1.0.5/README.md

@@ -0,0 +1,126 @@
+# Haiqu SDK: Quantum Performance Middleware for Python
+
+Haiqu is a middleware platform that bridges the gap between quantum hardware and practical applications. Haiqu SDK gives you programmatic access to the full Haiqu cloud stack: **error mitigation**, **circuit compression**, **hardware integration**, and **experiment tracking** - so you can run quantum circuits that actually work on today's noisy hardware.
+
+![Haiqu Stack](https://raw.githubusercontent.com/haiqu-ai/haiqu-sdk/main/images/image.webp)
+
+📖 **Full documentation**: [docs.haiqu.ai](https://docs.haiqu.ai/)
+
+## What You Can Do with Haiqu
+
+- **Error Shield:** automatic noise reduction preserves circuit fidelity without manual calibration
+- **Circuit Compression:** run circuits that would otherwise exceed hardware qubit and gate limits
+- **Data Loading:** linear-depth quantum data loading at practical scale
+- **Hardware Integration:** connect to major quantum processors and cloud platforms through a single API
+- **Experiment Tracking:** monitor job history, circuit measurements, and results across runs
+
+For example, using Haiqu SDK for a utility-scale Floquet dynamics simulation of the kicked Ising model on 103 qubits reduces quantum processor runtime from **~3.1 hours** to **~1 minute**, and lowers the estimated quantum cloud bill from **~$17,856** to **~$34**, while preserving accuracy close to the ideal result.
+
+![Kicked Ising Pareto Plot](https://raw.githubusercontent.com/haiqu-ai/haiqu-sdk/main/images/pareto.png)
+
+Want to see this in action? **[Book a demo](https://haiqu.ai/demoform)** to get access to this example and more.
+
+### Research results
+
+Haiqu's technology is backed by peer-reviewed research:
+
+- [Matrix Product States for shallow quantum circuit synthesis](https://arxiv.org/abs/2412.05202)
+- [Hamiltonian simulation via sub-block partitioning and state reconstruction](https://arxiv.org/abs/2412.15804)
+- [Rivet transpiler: caching and reuse for iterative quantum workloads](https://arxiv.org/abs/2508.21342)
+- [Fluid dynamics simulation without increasing circuit complexity](https://arxiv.org/abs/2510.17978)
+- [Large Hamiltonian evolution across multiple quantum processors](https://arxiv.org/abs/2502.03542)
+
+See also the [Haiqu Blog](https://blog.haiqu.ai/) for more exciting research from us.
+## Installation
+
+This repository contains the source code for the Haiqu SDK Python package. For users, It is recommended to install it from PyPI via `pip install haiqu-sdk` rather than to build from source. Refer to [Haiqu SDK Docs / Local Installation](https://docs.haiqu.ai/quickstart/qs_local) guide for more details. 
+
+> [!TIP]
+> Alternatively, you can request access to **Haiqu Lab**: a pre-built, hosted JupyterLab environment with everything
+> pre-installed and no local setup required. This can be done through your Haiqu account after sign-up.
+
+**Prerequisites** 
+- Python **3.10+** or Conda
+
+### Step 1: Set up a Python environment (recommended)
+
+Creating a virtual environment is optional, but highly recommended to avoid system-wide install and update of package dependencies. 
+
+**Venv** (available by default with Python)
+
+```bash
+python -m venv haiqu-env
+source haiqu-env/bin/activate
+```
+*Note:* on Windows systems, instead of the shell command on the last line above, run `.\haiqu-env\Scripts\activate.bat` to activate the environment.
+
+---
+
+**Conda**
+
+```bash
+conda create -y --name haiqu-sdk python=3.13
+conda activate haiqu-sdk
+```
+
+---
+
+**Virtualenv**
+
+```bash
+virtualenv haiqu-env --python ">=3.10"
+source haiqu-env/bin/activate
+```
+
+### Step 2: Install the SDK
+
+The latest version is available from PyPI
+```bash
+pip install haiqu-sdk
+```
+
+## Getting Access
+
+To use the Haiqu SDK you need an API key.
+
+**Request access here → [haiqu.ai](https://docs.haiqu.ai/quickstart/qs_intro)**
+
+After sign-up, your API key and access instructions will be delivered by email.
+
+Once you have a key, authenticate in your code:
+
+```python
+from haiqu.sdk import haiqu
+  
+# Login with your API key
+haiqu.login(api_access_key="ENTER_YOUR_API_KEY_HERE")  # or set the HAIQU_API_KEY env variable
+  
+# Initialize your first experiment
+haiqu.init("My First Quantum Experiment")
+```
+
+On success you will see:
+
+```
+Success: Welcome to the Quantum World, you@example.com!
+```
+
+You're all set. Refer to the [Getting Started](#getting-started) section to learn what you can do with Haiqu SDK.
+
+## Getting Started
+
+SDK example notebooks are coming soon — we will be releasing the **[sdk-examples](https://github.com/haiqu-ai/sdk-examples) repository** shortly. It will act as a tutorial for basic Haiqu SDK features with ready-to-run notebooks.
+
+In the meantime, see the [Core Features](https://docs.haiqu.ai/core_features/exp_tracking) section of the Haiqu SDK docs for guides, as well as the full [Haiqu SDK Reference](https://docs.haiqu.ai/reference/core/login).
+
+## AI-Assisted Development (MCP)
+
+Haiqu exposes MCP (Model Context Protocol) servers so you can use AI assistants like Claude or Cursor to execute circuits, query results, and browse documentation directly from your editor.
+
+See [MCP.md](/MCP.md) for configuration instructions for VS Code + Claude Code and Cursor.
+
+## Feedback and Support
+
+- **Documentation:** [docs.haiqu.ai](https://docs.haiqu.ai/)
+- **Email:** [info@haiqu.ai](mailto:info@haiqu.ai)
+- **Issues and feature requests:** open an issue in this repository or visit [feedback.haiqu.ai](https://feedback.haiqu.ai/)

haiqu_sdk-1.0.5/haiqu/sdk/__init__.py

@@ -0,0 +1,22 @@
+"""Haiqu SDK.
+
+The SDK provides programmatic access to Haiqu API service: log experiments,
+circuits, jobs and other user data.
+"""
+
+import importlib.metadata
+from .mpl_style import set_haiqu_mpl_style, unset_haiqu_mpl_style
+from .quantum_haiqu import Haiqu, haiqu
+from .utils import get_ibmq_temporary_token
+from .version import get_version
+
+__all__ = (
+    "get_version",
+    "get_ibmq_temporary_token",
+    "haiqu",
+    "Haiqu",
+    "set_haiqu_mpl_style",
+    "unset_haiqu_mpl_style",
+)
+
+__version__ = importlib.metadata.version("haiqu-sdk")