Build a workflow

Write, test, benchmark and publish your own workflow.

1. 1What a Qsolve workflow isA Qsolve workflow is a plain Qiskit program in a public Git repository plus a qsolve.yaml manifest; the SDK bridges to Qsolve, which runs and measures it.
2. 2Your first workflowBuild, test and submit a Qsolve workflow from scratch: install the SDK, scaffold with qsolve init, run, validate, lint, benchmark, push to GitHub and submit.
3. 3Project layoutThe files and folders of a Qsolve workflow repository, what each one is for, which are required, what is left out of the published snapshot and the size limits.
4. 4The manifestComplete reference for qsolve.yaml: every field, its type, default, valid values and limits, the error each mistake raises, how the platform uses it, and annotated examples from published workflows.
5. 5Writing the workflowThe contract of src/workflow.py: the Workflow class, what each method receives and returns, the Outcome object, solver details and how answers are rechecked.
6. 6Input and output schemasThe two JSON Schemas of a workflow, the rules both must follow, alternatives for the input, and where to find the full references.
7. 7Input schema referenceComplete reference for authoring schemas/input.json: which JSON Schema keywords the run form honours, every x-ui key with accepted values and effects, worked widget examples, validation rules and a pre-publish checklist.
8. 8Output schema referenceEverything about schemas/output.json: how the answer is validated, how each JSON shape is drawn for users, every x-ui hint the answer view reads, what happens on misuse, with examples from published workflows.
9. 9ParametersHow to declare parameters in qsolve.yaml: every field, the five types and their exact checks, ranges and choices, how defaults and overrides are validated, how the run form shows them and how they reach your code.
10. 10SDK referenceOverview of the qsolve-sdk Python package: install, import map of every module, how the pieces fit together, and which names are public API and which are internal.
11. 11SDK: the Workflow classReference for qsolve.workflow: Workflow and every method you override, Outcome, Context (including emit and report_mitigation), and the exceptions WorkflowError, InvalidSolution, MethodUnavailable and QuantumNotAllowed.
12. 12SDK: runner and manifestReference for qsolve.runner, qsolve.manifest and qsolve.comparison: run_workflow, estimate_run, validate_input, RunOutput, load_workflow, Manifest and its parts, run_methods, headline and implementation.
13. 13SDK: backends and the Qiskit bridgeReference for qsolve.backends and qsolve.bridge: targets and get_backend, Backend and AsyncBackend, AerBackend, FakeHardwareBackend, IBMBackend, RemoteBackend, QsolveBackend, QsolveSampler and QsolveEstimator.
14. 14SDK: metering and costReference for qsolve.metering and qsolve.sim: how the SDK records what crosses the backend, how fidelity and circuit size are measured, and how Estimate and run-time prediction feed the price quote.
15. 15SDK: results, events and circuit recordsReference for qsolve.results, qsolve.events and qsolve.circuit_record: every field of Result, MethodResult, Metrics, Quality, Mitigation, CircuitStats, Provenance, Uncertainty and Estimate, plus emit, capture and the drawable circuit records.
16. 16SDK: testing, linting and the sandboxReference for qsolve.benchmark, qsolve.lint and qsolve.sandbox_entry: run_benchmarks, the gate and case models, check_quality, check_estimate, lint_workflow, Finding, and the framed protocol of the sandbox entry point.
17. 17Backends and targetsHow workflow code runs circuits through QsolveBackend, QsolveSampler and QsolveEstimator on simulators, noise models and quantum computers, and what Qsolve meters.
18. 18Error mitigation and fidelityHow Qsolve measures fidelity, how to declare error mitigation with report_mitigation, how mitigated figures are scored and labelled, and what you may claim.
19. 19Lint codesEvery error and warning code that qsolve lint and the submission's static checks can report, what triggers it, the message and how to fix it.
20. 20BenchmarksEvery key of benchmarks/cases.yaml, the exact pass and fail rules, the eight validation gates, hardware cases, how results enter the track record and what the workflow page shows, with the lint code for each mistake.
21. 21The qsolve command lineReference for every qsolve command, argument and option: init, validate, lint, run, estimate and test, with defaults, exit codes, output formats, environment variables, error messages and examples.
22. 22Validation and publishingWhat happens when you submit a GitHub repository to Qsolve: the five stages, the checklist you see, limits and timeouts, how failures look and are fixed, and how a workflow is listed.
23. 23Private repositoriesPublish a workflow from a private GitHub repository: connect the Qsolve GitHub app, choose repositories, and what other people can and cannot see.
24. 24VersioningHow Qsolve versions a workflow: the semver string in qsolve.yaml, the content digest and what it covers, what happens when you resubmit a version, what is stored per version, which version runs and what happens to old results.
25. 25The seven example workflowsA walkthrough of the seven published Qsolve example workflows: what each solves, its inputs, outputs and parameters, and what to learn from reading its code.
26. 26TroubleshootingReal errors from qsolve lint, validation gates, the SDK and failed runs, with the cause of each and how to fix it, listed by the code or message you see.