quickqudits 1.0.1__tar.gz

quickqudits-1.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           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 [yyyy] [name of copyright owner]
+
+   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.

quickqudits-1.0.1/NOTICE

@@ -0,0 +1,7 @@
+QuickQudits
+Copyright 2026 Mykyta Cherniak and Nina Brandl
+
+Developed at the Department for Quantum Computing (QUICK),
+Johannes Kepler University Linz, Austria.
+
+Licensed under the Apache License, Version 2.0.

quickqudits-1.0.1/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: quickqudits
+Version: 1.0.1
+Summary: Simulation of noisy qudit Clifford circuits via extended stabilizer tableau formalism.
+Author-email: Mykyta Cherniak <mykyta.cherniak@jku.at>, Nina Brandl <nina.brandl@jku.at>
+License: Apache-2.0
+Project-URL: Homepage, https://quick-jku.github.io/QuickQudits/
+Project-URL: Repository, https://github.com/QUICK-JKU/QuickQudits
+Project-URL: Documentation, https://quick-jku.github.io/QuickQudits/
+Keywords: quantum,quantum computing,qudits,stabilizer formalism,Clifford circuits,noisy simulation,tableau,noise
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=1.26.4; python_version < "3.13"
+Requires-Dist: numpy>=2.1.0; python_version >= "3.13"
+Requires-Dist: sympy>=1.14.0
+Provides-Extra: numba
+Requires-Dist: numba>=0.61.0; extra == "numba"
+Provides-Extra: plot
+Requires-Dist: matplotlib>=3.8; extra == "plot"
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: qutip>=5; extra == "test"
+Requires-Dist: qiskit>=1.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: pdoc>=14; extra == "docs"
+Dynamic: license-file
+
+# quickqudits
+
+**QuickQudits** is a Python framework for efficient classical simulation of noisy qudit Clifford circuits using stabilizer tableau formalism, with Monte Carlo sampling of Pauli/Weyl noise.
+
+All dimensions are supported, with prime dimensions favoured.
+
+Core Functionality:
+- **Extended stabilizer tableaus** for qudits of arbitrary dimension `d`, storing X/Z exponents and a phase column, with Clifford updates over `Z_d`. 
+- **Measurement / post-measurement updates** via a generalized Aaronson–Gottesman (CHP-style) procedure for **prime** dimensions.
+- **Measurement** for **composite** dimensions via SNF.
+- **Noise modeling** as probabilistic mixtures of Weyl operators.
+- **Statevector / density-matrix backends** and circuit visualization utilities. 
+
+## Installation
+
+- Base:
+```bash
+pip install quickqudits
+```
+
+- With JIT speedups:
+```bash
+pip install "quickqudits[numba]"
+```
+
+- With plotting:
+```bash
+pip install "quickqudits[plot]"
+```
+
+- For dev/tests:
+```bash
+pip install "quickqudits[test]"
+```
+
+- Everything:
+```bash
+pip install "quickqudits[numba,plot,test]"
+```
+
+## Quick start
+
+```python
+import quickqudits as qq
+
+# initialize circuit
+n, d = 5, 3  # 5 qudits of dimension 3
+qc = qq.QuantumCircuit(n, d, name="example")
+
+# add gates
+qc.CXdag(2, 0)
+qc.CX(1, 0)
+qc.H(0)
+qc.H(1)
+qc.CXdag(0, 2)
+qc.CX(0, 4)
+qc.X(2)
+qc.S(4)
+qc.Hdag(4)
+qc.CXdag(2, 0)
+qc.Sdag(3)
+qc.CX(2, 0)
+qc.CZdag(4, 0)
+
+# add global depolarizing noise
+qc.add_noise_global(0.5)
+
+# visualize circuit
+qc.draw(show_info=True)
+```
+
+### Generated circuit
+
+The circuit produced by `qc.draw(show_info=True)`:
+
+![Example circuit](images/example_circuit.png)
+
+```python
+# initialize tableau
+tab = qq.Tableau(5, 3)
+
+# draw samples from the noisy circuit
+samples = tab.sample_measurements_noisy_pf(qc=qc, shots=5, seed=42)
+print(samples, end="\n\n")
+
+# execute the circuit and obtain tableau (ignoring noise channels)
+tab.apply_circuit(qc)
+
+# visualize tableau
+print(tab)
+```
+
+### Output
+
+```plaintext
+[[2 0 0 0 1]
+ [0 2 2 0 1]
+ [2 2 1 1 1]
+ [0 1 0 0 2]
+ [0 1 1 0 0]]
+
+#  | x0 x1 x2 x3 x4 | z0 z1 z2 z3 z4 | τ
+────────────────────────────────────────
+d0 |  0  0  0  0  0 |  1  0  0  0  0 | 0
+d1 |  0  0  0  0  0 |  1  1  0  0  0 | 0
+d2 |  0  0  1  0  0 |  2  0  0  0  0 | 0
+d3 |  0  0  0  1  0 |  0  0  0  2  0 | 0
+d4 |  0  0  0  0  1 |  2  0  0  0  2 | 4
+----------------------------------------
+s0 |  2  1  1  0  2 |  2  0  1  0  2 | 2
+s1 |  0  2  0  0  0 |  0  0  0  0  0 | 0
+s2 |  0  0  0  0  0 |  1  0  1  0  0 | 4
+s3 |  0  0  0  0  0 |  0  0  0  1  0 | 0
+s4 |  0  0  0  0  1 |  1  0  0  0  0 | 0
+```

quickqudits-1.0.1/README.md

@@ -0,0 +1,115 @@
+# quickqudits
+
+**QuickQudits** is a Python framework for efficient classical simulation of noisy qudit Clifford circuits using stabilizer tableau formalism, with Monte Carlo sampling of Pauli/Weyl noise.
+
+All dimensions are supported, with prime dimensions favoured.
+
+Core Functionality:
+- **Extended stabilizer tableaus** for qudits of arbitrary dimension `d`, storing X/Z exponents and a phase column, with Clifford updates over `Z_d`. 
+- **Measurement / post-measurement updates** via a generalized Aaronson–Gottesman (CHP-style) procedure for **prime** dimensions.
+- **Measurement** for **composite** dimensions via SNF.
+- **Noise modeling** as probabilistic mixtures of Weyl operators.
+- **Statevector / density-matrix backends** and circuit visualization utilities. 
+
+## Installation
+
+- Base:
+```bash
+pip install quickqudits
+```
+
+- With JIT speedups:
+```bash
+pip install "quickqudits[numba]"
+```
+
+- With plotting:
+```bash
+pip install "quickqudits[plot]"
+```
+
+- For dev/tests:
+```bash
+pip install "quickqudits[test]"
+```
+
+- Everything:
+```bash
+pip install "quickqudits[numba,plot,test]"
+```
+
+## Quick start
+
+```python
+import quickqudits as qq
+
+# initialize circuit
+n, d = 5, 3  # 5 qudits of dimension 3
+qc = qq.QuantumCircuit(n, d, name="example")
+
+# add gates
+qc.CXdag(2, 0)
+qc.CX(1, 0)
+qc.H(0)
+qc.H(1)
+qc.CXdag(0, 2)
+qc.CX(0, 4)
+qc.X(2)
+qc.S(4)
+qc.Hdag(4)
+qc.CXdag(2, 0)
+qc.Sdag(3)
+qc.CX(2, 0)
+qc.CZdag(4, 0)
+
+# add global depolarizing noise
+qc.add_noise_global(0.5)
+
+# visualize circuit
+qc.draw(show_info=True)
+```
+
+### Generated circuit
+
+The circuit produced by `qc.draw(show_info=True)`:
+
+![Example circuit](images/example_circuit.png)
+
+```python
+# initialize tableau
+tab = qq.Tableau(5, 3)
+
+# draw samples from the noisy circuit
+samples = tab.sample_measurements_noisy_pf(qc=qc, shots=5, seed=42)
+print(samples, end="\n\n")
+
+# execute the circuit and obtain tableau (ignoring noise channels)
+tab.apply_circuit(qc)
+
+# visualize tableau
+print(tab)
+```
+
+### Output
+
+```plaintext
+[[2 0 0 0 1]
+ [0 2 2 0 1]
+ [2 2 1 1 1]
+ [0 1 0 0 2]
+ [0 1 1 0 0]]
+
+#  | x0 x1 x2 x3 x4 | z0 z1 z2 z3 z4 | τ
+────────────────────────────────────────
+d0 |  0  0  0  0  0 |  1  0  0  0  0 | 0
+d1 |  0  0  0  0  0 |  1  1  0  0  0 | 0
+d2 |  0  0  1  0  0 |  2  0  0  0  0 | 0
+d3 |  0  0  0  1  0 |  0  0  0  2  0 | 0
+d4 |  0  0  0  0  1 |  2  0  0  0  2 | 4
+----------------------------------------
+s0 |  2  1  1  0  2 |  2  0  1  0  2 | 2
+s1 |  0  2  0  0  0 |  0  0  0  0  0 | 0
+s2 |  0  0  0  0  0 |  1  0  1  0  0 | 4
+s3 |  0  0  0  0  0 |  0  0  0  1  0 | 0
+s4 |  0  0  0  0  1 |  1  0  0  0  0 | 0
+```

quickqudits-1.0.1/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quickqudits"
+version = "1.0.1"
+description = "Simulation of noisy qudit Clifford circuits via extended stabilizer tableau formalism."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+
+authors = [
+  { name = "Mykyta Cherniak", email = "mykyta.cherniak@jku.at" },
+  { name = "Nina Brandl", email = "nina.brandl@jku.at" }
+]
+
+keywords = ["quantum", "quantum computing", "qudits", "stabilizer formalism", "Clifford circuits", "noisy simulation", "tableau", "noise"]
+
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+dependencies = [
+  "numpy>=1.26.4; python_version < '3.13'",
+  "numpy>=2.1.0; python_version >= '3.13'",
+  "sympy>=1.14.0",
+]
+
+[project.optional-dependencies]
+numba = [
+  "numba>=0.61.0",
+]
+
+plot = [
+  "matplotlib>=3.8",
+]
+
+test = [
+  "pytest>=8",
+  "qutip>=5",
+  "qiskit>=1.0",
+]
+
+docs = [
+  "pdoc>=14",
+]
+
+[project.urls]
+Homepage = "https://quick-jku.github.io/QuickQudits/"
+Repository = "https://github.com/QUICK-JKU/QuickQudits"
+Documentation = "https://quick-jku.github.io/QuickQudits/"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+license-files = ["LICENSE", "NOTICE"]
+
+[tool.setuptools.packages.find]
+where = ["src"]

quickqudits-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

quickqudits-1.0.1/src/quickqudits/__init__.py

@@ -0,0 +1,146 @@
+"""
+`quickqudits` is a library for the efficient classical simulation of Clifford circuits acting on d-dimensional qudits,
+including Pauli/Weyl noise.
+
+All dimensions are supported, with prime dimensions favoured.
+
+Core features:
+
+- Qudit stabilizer tableau simulator (`Tableau`) for `n` qudits of dimension `d`
+- Tableau phases tracked as powers of `τ mod 2d` (with `τ² = ω`)
+- A circuit container (`QuantumCircuit`) with Clifford/Weyl gates (allows statevector and density matrix simulation)
+- Noise channels (e.g., depolarizing-style Weyl noise) and fast Monte-Carlo sampling utilities
+- Optional Numba acceleration for fast tableau updates
+- High-level tools and helpers for tableaus/statevectors/density matrices, fidelity estimation, random circuits, etc.
+
+---
+
+## Example
+
+```python
+import quickqudits as qq
+
+# initialize circuit
+n, d = 5, 3 # 5 qudits of dimension 3
+qc = qq.QuantumCircuit(n, d)
+
+# add gates
+qc.CXdag(2, 0)
+qc.CX(1, 0)
+qc.H(0)
+qc.H(1)
+qc.CXdag(0, 2)
+qc.CX(0, 4)
+qc.X(2)
+qc.S(4)
+qc.Hdag(4)
+qc.CXdag(2, 0)
+qc.Sdag(3)
+qc.CX(2, 0)
+qc.CZdag(4, 0)
+
+# add global depolarizing noise
+qc.add_noise_global(0.5)
+
+# visualize circuit
+qc.draw(show_info=True)
+
+# initialize tableau
+tab = qq.Tableau(5, 3)
+
+# draw samples from the noisy circuit
+samples = tab.sample_measurements_noisy_pf(qc=qc, shots=5, seed=42)
+print(samples, end='\\n\\n')
+
+# execute the circuit and obtain tableau (ignoring noise channels)
+tab.apply_circuit(qc)
+
+# visualize tableau
+print(tab)
+```
+
+Output:
+```plaintext
+[[2 0 0 0 1]
+ [0 2 2 0 1]
+ [2 2 1 1 1]
+ [0 1 0 0 2]
+ [0 1 1 0 0]]
+
+#  | x0 x1 x2 x3 x4 | z0 z1 z2 z3 z4 | τ
+────────────────────────────────────────
+d0 |  0  0  0  0  0 |  1  0  0  0  0 | 0
+d1 |  0  0  0  0  0 |  1  1  0  0  0 | 0
+d2 |  0  0  1  0  0 |  2  0  0  0  0 | 0
+d3 |  0  0  0  1  0 |  0  0  0  2  0 | 0
+d4 |  0  0  0  0  1 |  2  0  0  0  2 | 4
+----------------------------------------
+s0 |  2  1  1  0  2 |  2  0  1  0  2 | 2
+s1 |  0  2  0  0  0 |  0  0  0  0  0 | 0
+s2 |  0  0  0  0  0 |  1  0  1  0  0 | 4
+s3 |  0  0  0  0  0 |  0  0  0  1  0 | 0
+s4 |  0  0  0  0  1 |  1  0  0  0  0 | 0
+```
+
+## Modules
+
+- `circuit` — `QuantumCircuit`: build circuits, run statevector/density simulations, sampling helpers
+- `tableau` — `Tableau`: stabilizer tableau evolution, measurement, conversions, noisy sampling
+- `tableau_composite` — `CompositeTableau`: composite d
+- `io.tableau_io` — save/load tableaus via compressed NumPy `.npz`
+- `io.circuit_io` — save/load circuits via compressed NumPy `.npz`
+- `accelerators.numba_fast` — Numba JIT kernels for fast tableau updates (optional)
+- `backend` — global dtype/precision configuration (`set_precision`)
+- `gate_class` — `Gate` and `NoiseChannel` definitions
+- `gates` — numerical matrix builders for standard qudit gates
+- `predefined_gates` — pre-instantiated gate objects (e.g. `H_gate`, `CNOT_gate`, …)
+- `visualization` — Matplotlib circuit drawing backend
+- `utils` — utilities (see below)
+
+`utils` submodules:
+
+- `utils.circuit_utils` — small circuit constructors (e.g. universal input-state prep)
+- `utils.random_circuits` — random circuit generator (`random_circuit`)
+- `utils.statevector` — statevector helpers (projection, sampling, comparisons, etc.)
+- `utils.density` — density-matrix helpers (validity checks, purity, probvectors)
+- `utils.fidelity` — Monte-Carlo fidelity estimators for noisy circuits
+- `utils.entanglement` — Schmidt-rank utilities for stabilizer states
+- `utils.tableau_utils` — Numba warmup + tableau symplectic checks
+
+---
+
+## Main classes and utilities
+
+Classes:
+
+- `QuantumCircuit` — build / store circuits; provides simulation + sampling routines
+- `Tableau` — stabilizer tableau representation for qudit Clifford simulation
+- `CompositeTableau` — stabilizer tableau for composite d
+- `Gate` — gate metadata + matrix generation logic
+- `NoiseChannel` — gate subclass representing noise models
+
+Selected utilities:
+
+- `utils.random_circuit`
+- `utils.fidelity_pf`
+- `utils.fidelity_np`
+- `utils.check_symplectic_structure`
+- `utils.get_projected_state`, `utils.compare_statevectors`, `utils.apply_unitary`, `utils.measureall`
+- `utils.get_zero_density_matrix`, `utils.is_valid_density_matrix`, `utils.purity`
+- ...
+
+See utils documentation for the rest.
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("quickqudits")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+from . import backend, io, utils
+from .circuit import QuantumCircuit
+from .predefined_gates import *
+from .tableau import Tableau
+from .tableau_composite import CompositeTableau