Skip to content
QubitHub QubitHub Docs

Contributing Circuits

Overview

Section titled “Overview”

Publishing a circuit to QubitHub involves three files:

  1. circuit.py — your quantum circuit code
  2. qubithub.toml — manifest describing the circuit
  3. README.md — documentation for users

Scaffold a new circuit

Section titled “Scaffold a new circuit”
Terminal window
qubithub circuits init my-circuit --framework qiskit

Write your circuit

Section titled “Write your circuit”

Your circuit.py must define a create_circuit() function that returns a framework-specific circuit object.

Push to QubitHub

Section titled “Push to QubitHub”
Terminal window
qubithub circuits push

The CLI validates your qubithub.toml and uploads all files.

Quality checklist

Section titled “Quality checklist”
  • Circuit executes without errors
  • README explains the algorithm (intuition, math, implementation)
  • TOML manifest has accurate metadata (qubits, gates, difficulty)
  • Code follows framework best practices

Next steps

Section titled “Next steps”