Skip to content
QubitHub QubitHub Docs

Web UI Getting Started

This guide walks you through using QubitHub entirely from the browser. No installation required.

Time to complete: ~10 minutes

1. Browse the circuit library

Section titled “1. Browse the circuit library”

Visit qubithub.co/circuits to explore the full library. No account needed.

You can filter circuits by:

  • Framework — Qiskit, PennyLane, or Cirq
  • Tags — entanglement, optimization, qml, error-correction, and more
  • Qubit count — 1–5, 6–10, 11–20, or 20+
  • Sort — newest, most starred, most runs, or most views

Each circuit card shows the title, framework, qubit count, star count, and tags.

2. Try the live demo

Section titled “2. Try the live demo”

The landing page includes an interactive demo section where you can:

  • View a Bloch sphere — drag to rotate the 3D single-qubit state visualization
  • Explore state vectors — see amplitude and phase for multi-qubit states
  • Try preset quantum states: |0>, |1>, |+>, |−>, Bell states, GHZ, and W states

This runs entirely in the browser — no backend execution needed.

3. View a circuit

Section titled “3. View a circuit”

Click any circuit card to open its detail page. You’ll see:

  • File browser (left sidebar) — browse the circuit’s files: circuit.py, README.md, qubithub.toml, metadata.json
  • README tab — full documentation rendered from markdown, with math support (KaTeX)
  • Metadata panel — framework, qubit count, gate list, version, and creation date
  • Runs tab — execution history with status, backend, shots, and timing
  • Settings tab — circuit configuration (for circuit owners)

4. Create an account

Section titled “4. Create an account”

To fork, star, or execute circuits, you need an account.

  1. Go to qubithub.co/register
  2. Fill in your name, username, email, and password
  3. Click Create Account

You’ll be logged in automatically and redirected to your dashboard.

5. Star and fork circuits

Section titled “5. Star and fork circuits”

Once logged in, you can interact with circuits:

  • Star — click the star icon to bookmark a circuit. Stars are public and help others discover quality circuits.
  • Fork — create a personal copy of any circuit under your namespace. Your fork is independent — edit it freely.
  • Share — copy a direct link to the circuit or use your browser’s native share dialog.

6. Execute a circuit

Section titled “6. Execute a circuit”

From a circuit’s detail page:

  1. Click the Execute button (visible at the top of the page)
  2. Choose a backend (default: Qiskit Aer simulator)
  3. Set shots (number of measurement repetitions, default: 1024)
  4. Click Run

Results appear in the Runs tab once execution completes (typically under 3 seconds for simulator backends).

7. Explore visualizations

Section titled “7. Explore visualizations”

After a run completes, QubitHub renders rich visualizations of the results:

VisualizationWhat it shows
Measurement histogramBar chart of outcome probabilities
Bloch sphereInteractive 3D view of single-qubit states
State vectorAmplitude and phase for each basis state
Density matrixFull quantum state representation
Circuit diagramGate-level circuit visualization

All visualizations support:

  • Dark mode
  • Screenshot export (save as image)
  • Copy to clipboard

8. Use the dashboard

Section titled “8. Use the dashboard”

Your dashboard is the control center:

  • Overview — your circuits, recent runs, and activity
  • API Keys — create and manage keys for CLI and SDK access
  • Usage — execution quota tracking (coming soon)
  • Organizations — team namespace management (coming soon)
  • Ops — operational activity monitoring

9. Organizations

Section titled “9. Organizations”

Organizations let teams share circuits under a common namespace (e.g., my-quantum-lab/bell-state).

Roles:

  • Owner — full admin, billing, delete org, change member roles
  • Admin — add/remove members, manage circuits
  • Member — create and edit circuits

Next steps

Section titled “Next steps”