Skip to main content

A beginner-friendly Python layer for running and visualizing introductory quantum demos.

Project description

quantum-starter-lab

PyPI version Python versions License CI

A single, beginner-friendly Python layer that wraps the most common introductory quantum tasks so newcomers can learn and build quickly.

Created by Pranava Kumar


Key Features

  • 🚀 One-Line Demos: Run classic quantum algorithms like Bell's state, Grover's search, and Teleportation with a single function call.
  • 🔬 Intuitive Noise Simulation: Easily compare ideal results with noisy ones to build an intuition for the challenges of real hardware.
  • 📊 Visual, Explain-First Outputs: Get beautiful plots and plain-language explanations of "what just happened" with every run.
  • 🔄 Framework-Agnostic: Start with Qiskit's simulator by default, and switch to Google's Cirq with a single parameter.

Quick Start

Installation

Requires Python 3.10 or newer. Install with uv: uv add quantum-starter-lab

Example Usage

Create and visualize a Bell state with a bit of noise in just a few lines of Python: from quantum_starter_lab.api import make_bell

Run a Bell state demo with 1% bit-flip noise results = make_bell(noise_name="bit_flip", p=0.01, seed=42)

Print the simple explanation and counts print(results)

Show the circuit diagram and histogram plot results.plot()

Contributing

Contributions are welcome! Whether it's reporting a bug, suggesting a new feature, or submitting code, your help is valued. Please see our Contributing Guidelines to get started.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Acknowledgements

This project was created and is maintained by Pranava Kumar.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quantum_starter_lab-0.1.3.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quantum_starter_lab-0.1.3-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file quantum_starter_lab-0.1.3.tar.gz.

File metadata

  • Download URL: quantum_starter_lab-0.1.3.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for quantum_starter_lab-0.1.3.tar.gz
Algorithm Hash digest
SHA256 636a78d2524eca605226bedecd6899e564a610a04d1772c6859f2d179417cf60
MD5 b528464b81244d218848f6610c932032
BLAKE2b-256 ac7d14acdfbe525162b84250d8a6f55b9392e8ec9e2eb99b763f77f8b2bd8021

See more details on using hashes here.

Provenance

The following attestation bundles were made for quantum_starter_lab-0.1.3.tar.gz:

Publisher: release.yml on Pranava-Kumar/quantum-starter-lab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quantum_starter_lab-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for quantum_starter_lab-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7f53d1ea12e394463a4abfaafdcef74a214351aff7e61a541ed271debf44aa20
MD5 ba06f6512687415664985fa52328cd5d
BLAKE2b-256 e6e1f3c90c0ebb04e707fec40565ece52c798d865b6bf86f7eb686fd627a8b0b

See more details on using hashes here.

Provenance

The following attestation bundles were made for quantum_starter_lab-0.1.3-py3-none-any.whl:

Publisher: release.yml on Pranava-Kumar/quantum-starter-lab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page