# Kipu Quantum Hub Docs > Documentation for the Kipu Quantum Hub For any documentation page at `https://docs.hub.kipu-quantum.com/`, the markdown source is available at `https://docs.hub.kipu-quantum.com/.md`. ## Table of Contents ### Getting Started - [01-01 — Quickstart](/quickstart.md): Crash course covering CLI installation, Quantum SDK setup, and running a full quantum workflow from development to deployment on Kipu Quantum Hub. ### Implementations - [02-01 — Introduction](/implementations/introduction.md): Overview of Implementations, the Git-backed repositories on Kipu Quantum Hub for storing, versioning, and collaborating on quantum code. - [02-02 — Getting started](/implementations/getting-started.md): Create an implementation repository, clone it locally with a personal access token, and push your first commit to Kipu Quantum Hub. - [02-03 — Implementation Settings](/implementations/settings.md): Manage implementation visibility and assign Viewer, Maintainer, or Owner roles to collaborators on Kipu Quantum Hub. - [02-04 — Create a Service](/implementations/create-a-service.md): Bootstrap a Docker Python starter project, push it to an implementation, and turn it into a Managed Service using qhubctl. ### Managed Services - [03-01 — Introduction](/services/managed/introduction.md): Overview of Managed Services, the containerized on-demand runtime for deploying quantum code to Kipu Quantum Hub via CLI or UI. - [03-02 — Service Configuration](/services/managed/service-configuration.md): Configure runtime, resources, provider access tokens, and environment variables for a deployed Managed Service. - [03-03 — Describe your API using OpenAPI Specification v3.0](/services/managed/openapi.md): Document Managed Service endpoints, inputs, and outputs using OpenAPI v3 so users understand how to call and consume your API. - [03-04 — Run as a Job](/services/managed/jobs.md): Execute Managed Services asynchronously as jobs, store their results, and share outcomes with other users via the Job Dashboard. - [03-05 — Using Data Pools in Services](/services/managed/datapool.md): Attach Data Pools to Managed Services and use the qhub-commons DataPool class to read mounted files at runtime. - [03-06 — Using Secrets in Services](/services/managed/secrets.md): Use the SecretValue class from qhub-commons to securely inject API tokens and credentials as environment variables into Managed Services. - [03-07 — Custom Docker Containers](/services/managed/custom-containers.md): Package a Managed Service as a custom Docker container to bring your own OS packages, languages, or reproducible builds to Kipu Quantum Hub. - [03-08 — Runtime Interface](/services/managed/runtime-interface.md): Lifecycle, input handling, and output contract for the Python Template and Docker runtime configurations that power Managed Services. ### Using a Service - [04-01 — Applications](/services/applications.md): Create Applications with Access Key ID and Secret Access Key credentials to request bearer tokens and securely call services on Kipu Quantum Hub. - [04-02 — Using a Service](/services/using-a-service.md): Subscribe to an internally published service or a marketplace service with an Application and obtain credentials to call its HTTP API. - [04-03 — Sharing Services](/services/sharing-services.md): Share services privately with specific users or organizations, with optional time-based constraints, without publishing to the marketplace. ### Quantum Workflows - [05-01 — Building an Air Traffic Management Workflow with Quantum Computing](/services/workflow/air-traffic-tutorial.md): End-to-end BPMN workflow tutorial solving an air traffic graph-coloring problem by orchestrating quantum services on Kipu Quantum Hub. - [05-02 — Automatic API Generation](/services/workflow/api-generation.md): Define a JSON Schema on a workflow Start Event to auto-generate OpenAPI docs, validate inputs, and type the workflow service API. - [05-03 — Data Manipulation in Workflows](/services/workflow/data-manipulation.md): Transform, filter, and aggregate workflow data using FEEL expressions for variables, strings, numbers, comparisons, and arrays. - [05-04 — Common Workflow Compositions](/services/workflow/common-workflow-compositions.md): Patterns for composing BPMN workflows including fan-out/fan-in, pipelines, and conditional flows using exclusive gateways. - [05-06 — Handling Errors in Workflow Services](/services/workflow/error-handling.md): Catch platform service-task failures with a boundary error event and consume the failure envelope via the auto-injected per-host `_serviceError` process variable. - [Notify and Ask Users](/services/workflow/user-tasks.md): Pause a workflow for a human decision or notify a user with a Platform User Task; the recipient responds from the in-app notification panel. - [05-05 — Using Secrets in Workflow Services](/services/workflow/secrets.md): Pass SecretValue parameters securely to orchestrated services by defining a $secrets input variable in your workflow configuration. ### On-Premise Services - [06-01 — Introduction](/services/on-premise/introduction.md): Integrate, commercialize, and monetize self-hosted quantum services on Kipu Quantum Hub while keeping them on your own infrastructure. - [06-02 — Publish on Marketplace](/services/on-premise/publish-marketplace.md): Add an OpenAPI description, create a pricing plan, and publish an on-premise service to the Kipu Quantum Hub Marketplace. - [06-03 — Report Service Usage](/services/on-premise/report-usage.md): Report usage events from on-premise services to the Kipu Quantum Hub Metering API so customers can be billed per product item. ### Agent Integration - [07-01 — Agent-Ready with MCP Server](/agentic/mcp-server.md): Connect AI assistants like Claude, Cursor, and GitHub Copilot to Kipu Quantum Hub via the hosted MCP server to manage quantum resources in natural language. - [07-02 — Tutorial: Quantum Application Development with Kipu Quantum Hub MCP Server](/agentic/usecase-to-service-agentic.md): Build, test, and deploy a quantum service end-to-end using qhubctl and the Kipu Quantum Hub MCP server with an AI coding assistant. ### Platform and Administration - [08-01 — Manage Quantum Jobs](/manage-quantum-jobs.md): Monitor, cancel, and retrieve results of quantum jobs submitted via the SDK or by managed services through the Quantum Jobs dashboard. - [08-07 — Manage Organizations](/manage-organizations.md): Create organizations, invite members with Viewer, Maintainer, or Owner roles, and switch account context for team collaboration. - [08-08 — Manage Access Tokens](/manage-access-tokens.md): Create and manage Personal Access Tokens for platform API access and Provider Access Tokens for bring-your-own quantum backend credentials. - [08-09 — Manage Git Integrations](/manage-git-integrations.md): Connect GitHub and GitLab accounts to your user or organization to import repositories and enable automatic builds on the Kipu Quantum Hub. #### Use Cases - [08-02 — Use Cases](/usecases/introduction.md): Document industrial quantum use cases with details, authors, demos, sketches, and relations to algorithms and services on Kipu Quantum Hub. ##### Demos - [08-03 — Introduction](/usecases/demos/introduction.md): Overview of Demos, interactive web interfaces for quantum use cases deployed from GitHub or GitLab repositories on Kipu Quantum Hub. - [08-04 — Deploy a Demo](/usecases/demos/deploy-demo.md): Connect a GitHub repository to deploy a Demo, with required host, port, and CORS configuration for Kipu Quantum Hub integration. - [08-05 — Set Environment Variables](/usecases/demos/environment-variables.md): Configure environment variables in Demo settings to pass Application credentials and other secrets to your deployed demo code. - [08-06 — Starter Templates](/usecases/demos/starter-templates.md): Community-contributed Gradio, Nuxt, and SPA starter templates for bootstrapping Demo applications on Kipu Quantum Hub. ### References - [09-00 — References Overview](/references.md): Landing page for Kipu Quantum Hub SDKs and CLI. Pick the right tool (qhub-quantum, qhub-service, qhub-api, qhubctl) for your task with a decision matrix and install cheat-sheet. - [09-01 — Quantum SDK Reference](/sdk-quantum.md): Run Qiskit and Amazon Braket circuits on Kipu Quantum Hub backends via HubQiskitProvider, HubQiskitRuntimeService, and HubBraketProvider. - [09-02 — Service SDK Reference](/sdk-service.md): Install and use the qhub-service SDK in Python or TypeScript to execute services, submit jobs, and retrieve results programmatically. - [CLI Reference](/cli-reference.md) - [09-06 — `qhub.json` Reference](/qhub-json-reference.md): Reference for the qhub.json service configuration file, including supported fields for name, resources, runtime, and GPU allocation. - [09-07 — Markdown & LaTeX](/references/markdown-latex-editor.md): Reference for Markdown, KaTeX-powered LaTeX, QuanTikz circuits, image scaling, and sketch embedding in platform text editors. #### API SDK - [09-03 — API SDK Reference](/sdk-api.md): Multi-language clients for the Kipu Quantum Hub REST APIs - submit quantum jobs and manage sessions, list and inspect backends, catalog and share services and data pools, and execute managed services. - [09-03-01 — Quantum API](/sdk-api-quantum.md): Submit quantum jobs and manage sessions, list and inspect backends, and stream results through the HubQuantumClient. - [09-03-02 — Platform API](/sdk-api-platform.md): Catalog surface for the Kipu Quantum Hub - services, applications, organizations, data pools, subscriptions, marketplace listings, and billing through the HubPlatformClient. - [09-03-03 — Service API](/sdk-api-service.md): Invoke deployed services through the Kipu Quantum Hub gateway with the HubServiceClient - start executions, stream logs, and download result files using short-lived bearer tokens. - [09-03-04 — User API](/sdk-api-user.md): Read user profiles, manage personal access tokens, resolve user identities, and search the user directory with the HubUserClient. ### Other - [A Workflow Example](/services/orchestration/example.md): Walkthrough combining a stock time series service and a covariance generator into a single orchestrated workflow on Kipu Quantum Hub. - [Access IBM Quantum Platform Backends in a Service](/tutorials/tutorial-ibmq.md): Build a service that uses qiskit-ibm-provider to generate random numbers on the least busy IBM Quantum Platform backend. - [BPMN Workflow Tutorial](/services/workflow/introduction.md): Introduction to BPMN workflow fundamentals for orchestrating multi-step quantum services visually on Kipu Quantum Hub. - [Execute Qiskit Circuits using the Quantum SDK](/tutorials/tutorial-qiskit-with-platform-sdk.md): Use HubQiskitProvider from the Quantum SDK to list backends and execute Qiskit circuits on quantum hardware and simulators. - [Introduction](/services/orchestration/introduction.md): Compose new services from existing ones using BPMN-based Service Orchestration powered by a Camunda workflow engine. - [KQH Service API Description](/public/files/openapi/README.md) - [Solving the Maximum Independent Set Problem on QuEra Aquila using the Quantum SDK](/tutorials/tutorial-quera-mis.md): Solve the Maximum Independent Set problem on QuEra Aquila via Analog Hamiltonian Simulation using the Quantum SDK Braket wrapper. - [The Workflow Editor](/services/orchestration/workflow-editor.md): Design BPMN workflows visually using service tasks, gateways, and data map objects to orchestrate subscribed platform services. - [Tutorials](/tutorials.md): Index of hands-on tutorials covering Data Pools, Qiskit, QuEra Aquila, IBM Quantum, Qiskit Runtime, and local Service SDK development. - [Use Qiskit Runtime in a Service](/tutorials/tutorial-qiskit-runtime.md): Build a service that uses qiskit-ibm-runtime sessions and samplers to run circuits on IBM Quantum Platform backends. - [Using Data Pools in Managed Services](/tutorials/tutorial-datapool.md): Hands-on tutorial building, deploying, and consuming a text analysis service that processes documents stored in Kipu Quantum Hub Data Pools. - [Utilize the Service SDK for Local Development](/tutorials/tutorial-local-development.md): Run services locally with qhubctl serve and interact with them via the Service SDK to iterate before deploying to Kipu Quantum Hub.