Documentation Index

Fetch the complete documentation index at: https://docs.qbraid.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Adding Your Project

This guide walks partners through contributing a solution or project to the qBraid Explore page so users can discover it and run it out-of-the-box on the qBraid Lab platform.

​

Step 1: Create a Public GitHub Repository

Create a public GitHub repository with the code for your solution or project. Content can take many forms: example notebooks, executable Python files, or code in other languages (e.g., C++ or Julia). Include a detailed README that describes the project and explains how to use it. See existing examples or reach out for guidance. We’ll review your README and give feedback. If it isn’t a good fit for the Explore page (e.g., the README doesn’t clearly describe the project’s content, or it contains setup instructions that aren’t applicable to qBraid), we may ask you to add a separate markdown file with qBraid-specific content. We can link to that file so it’s what users see when they open your project on the platform.

​

Step 2: Send Us Environment and Project Details

Send all of the following in a single email to contact@qbraid.com or other qBraid point of contact. We’ll use it to create your environment and add your project listing.

​

Environment details

• Dependencies — A minimal list of required packages (e.g., as you would put in a requirements.txt or pyproject.toml). Do not send a full pip list; we need only what’s minimally required to run your code and examples.
• Logos — Square logos in light and dark versions. We’ll use them for both the environment sidebar image and the kernel logo.
• Non-Python or GPU? — If your project needs a different runtime (e.g., not Python) or GPUs, say so in the email. We can set up a custom Docker container or GPU accommodations and will align with you on requirements.

​

Project details

• Short description — 1–2 sentences for the Explore page.
• Tags — Terms to make the project searchable.
• GitHub repository URL — The public repo from Step 1.

​

Step 3: What Happens Next

We will create the environment and share it with your qBraid account. Test it (discoverable in Shared environments on Lab), and tell us if anything needs to change. Once you’re happy with it, we’ll add your project to the Explore page. Review the listing and let us know if any final modifications are needed.

​

Questions?

Reach out to contact@qbraid.com or your qBraid point of contact.