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

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

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

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

QubitHub is open — anyone can register. There’s no waitlist gate.

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. Agree to the Terms of Service and Privacy Policy (a checkbox)
4. Click Create Account

You’ll be logged in immediately and redirected to your dashboard. A verification email lands within seconds — see the Account & Email Verification guide for what to expect and what to do if it doesn’t arrive.

Verification is required before publishing

You can browse the library before verifying your email, but creating circuits, forking, and executing your own circuits are gated on a verified address.

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

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

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

Visualization	What it shows
Measurement histogram	Bar chart of outcome probabilities
Bloch sphere	Interactive 3D view of single-qubit states
State vector	Amplitude and phase for each basis state
Density matrix	Full quantum state representation
Circuit diagram	Gate-level circuit visualization

All visualizations support:

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

8. Share a run

Every run has its own URL — qubithub.co/<owner>/<circuit>/runs/<run-id> — and anyone with the link can view runs of a public circuit (no login required).

Link previews: When you paste a run URL into Slack, X, BlueSky, Discord, or a docs page, the platform serves a server-rendered 1200×630 preview image with the circuit name, status, framework, and the result histogram. The image is regenerated whenever the circuit is renamed or the run state changes, so old previews don’t go stale.

The preview also includes Open Graph + Twitter Card + JSON-LD metadata, so links unfurl correctly across every major surface.

Search-engine discoverability: Public circuits, terminal runs, user profiles, and organizations are listed in qubithub.co/sitemap.xml. The site’s robots.txt points search-engine crawlers at the sitemap, so a freshly-published circuit can be indexed without you doing anything extra.

Note

Private circuits aren’t included in the sitemap, and their run URLs return a 404 image to anonymous visitors — sharing a private run link doesn’t leak the circuit’s existence.

9. 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

First-run onboarding

If your dashboard is empty — no circuits yet — the Overview tab shows a 3-card first-run prompt instead of an empty grid:

Card	What it does
Try a curated circuit	Jumps to the curated library (Bell state, Grover, VQE, etc.) — fork-and-run starting points
Create your own	Goes to /circuits/new with starter templates (empty / Bell / VQE / QAOA) and toggles for README / manifest / .gitignore scaffolding
60-second tutorial	The Web UI Guide you’re reading now

The prompt disappears the moment you have at least one circuit. If you ever return to an empty dashboard (e.g. after deleting all your circuits), the prompt reappears.

Note

The prompt is gated on a successful circuit-list fetch — if the API call fails, the dashboard shows its loading / error state instead of the empty-state prompt. Seeing the prompt always means “the platform confirmed you have zero circuits,” never “the API is broken.”

10. 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

Note

Organization creation is available via the API and the CLI. A dashboard UI for creating organizations is on the post-beta roadmap; once an organization exists, you can transfer circuits into it from any circuit’s Settings tab.

Next steps

• CLI / SDK Quickstart — power-user workflow from the terminal
• Contributing Circuits — publish your own circuits
• FAQ — common questions about QubitHub