Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .internal/docs/explore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ search:

# Classiq Library

This chapter contains a wide variety of functions, algorithms, applications and tutorials of quantum programs with Classiq. Everything can also be found in the [Classiq Git Library](https://github.com/Classiq/classiq-library), where you can contribute your own tutorials and algorithms that will appear in this documentation as well. In addition, all the examples can be found directly in the [Classiq platform](https://platform.classiq.io/) in the `Model` tab.
This chapter contains a wide variety of functions, algorithms, applications and tutorials of quantum programs with Classiq. Everything can also be found in the [Classiq Git Library](https://github.com/Classiq/classiq-library), where you can contribute your own tutorials and algorithms that will appear in this documentation as well. In addition, all the examples can be found directly in the [platform](https://platform.classiq.io/) in the `Model` tab.

<!-- prettier-ignore-start -->
!!! tip
Expand Down
8 changes: 4 additions & 4 deletions .internal/docs/getting-started/classiq_tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ search:
boost: 3.200
---

# The Classiq Tutorial
# Onboarding Tutorial

Welcome to The Classiq Tutorial!
Welcome to the Onboarding Tutorial!

This is the place to gain hands-on experience in high-level quantum programming.

The tutorial consists of the following sections:

1. [Classiq Overview Tutorial](../classiq_tutorial/classiq_overview_tutorial.ipynb) - a full workflow with classiq, from designing a simple quantum model to execution and post processing the results.
1. [Overview Tutorial](../classiq_tutorial/classiq_overview_tutorial.ipynb) - a full workflow with classiq, from designing a simple quantum model to execution and post processing the results.
2. Qmod Tutorial - introducing the Qmod language and its accompanying library. These are the building blocks of every quantum model.
1. [Part 1](../classiq_tutorial/Qmod_tutorial_part1.ipynb) covers basic concepts and functions, which are relevant in most use-cases.
2. [Part 2](../classiq_tutorial/Qmod_tutorial_part2.ipynb) goes into more advanced topics. Grasping these tools and ideas opens the door to a whole world of quantum algorithms and applications.
3. [Synthesis tutorial](../classiq_tutorial/synthesis_tutorial.ipynb) - introducing Classiq's synthesis engine and explaining how to use it for optimization of the resulting quantum program.
3. [Synthesis tutorial](../classiq_tutorial/synthesis_tutorial.ipynb) - introducing the synthesis engine and explaining how to use it for optimization of the resulting quantum program.
4. Execution tutorial - How to execute quantum programs, and how to post-process their outputs.
1. [Part 1](../classiq_tutorial/execution_tutorial.ipynb) introduces how to execute a quantum program and process the sampling outputs.
2. [Part 2](../classiq_tutorial/execution_tutorial_part2.ipynb) covers measurement of observables, execution of parameterized quantum circuits, and a workflow for variational quantum algorithms.
2 changes: 1 addition & 1 deletion .internal/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ search:

Welcome to Classiq!

This section will guide you through [**Registration & Installation**](registration_installations.md) and introduce you to the [**Classiq Tutorial**](classiq_tutorial/index.md), where you'll quickly gain hands on experience with high-level quantum programming.
This section will guide you through [**Registration & Installation**](registration_installations.md) and introduce you to the [**Onboarding Tutorial**](classiq_tutorial/index.md), where you'll quickly gain hands on experience with high-level quantum programming.

We also invite you to join our [**Community Slack**](https://short.classiq.io/join-slack), where you can get technical support, exchange ideas, and connect with fellow users.
14 changes: 7 additions & 7 deletions .internal/docs/getting-started/registration_installations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ search:

# Registration and Installation

To use [Classiq platform](https://platform.classiq.io/) for free for non-commercial purposes, you must register. Then you can optionally use our coding studio (web-based IDE) or install the Python SDK package and authenticate your account. This page guides you through the steps.
To use the [platform](https://platform.classiq.io/) for free for non-commercial purposes, you must register. Then you can optionally use our coding studio (web-based IDE) or install the Python SDK package and authenticate your account. This page guides you through the steps.

## Registration

Expand All @@ -21,7 +21,7 @@ Fill in the requested information:
<img src="https://docs.classiq.io/resources/signup_further_info.png" style="width:70%;" />
</div>

Upon completion, you will be directed to the Classiq platform home page.
Upon completion, you will be directed to the platform's home page.

## Slack Registration

Expand All @@ -31,14 +31,14 @@ Classiq has a vibrant and active [Slack community](https://short.classiq.io/join
<img src="https://docs.classiq.io/resources/signup_slack.png" style="width:70%;" />
</div>

## Classiq Studio
## Studio

The Classiq platform has a web-based code editor, that allows you to create and run Python code with a pre-set environment. You can access it through the [Classiq Platform](https://platform.classiq.io/).
For more information check out our [Classiq Studio user guide](../user-guide/classiq-studio/index.md)
The platform has a web-based code editor, that allows you to create and run Python code with a pre-set environment. You can access it through the [platform](https://platform.classiq.io/).
For more information check out our [Studio user guide](../user-guide/studio/index.md)

## Python SDK Installation

The Classiq platform has an accompanying Python SDK package that is integrated with the Classiq platform. **After registering to the platform**, install the SDK package using `pip`:
The platform has an accompanying Python SDK package that is integrated with the platform. **After registering to the platform**, install the SDK package using `pip`:

**NOTE** - The SDK is currently supported for Python versions `3.8` to `3.12`.

Expand Down Expand Up @@ -89,7 +89,7 @@ If you encounter an issue, look for a solution in the [troubleshooting section](

## Platform Version Updates

Every few weeks a new version of the Classiq platform launches. The web-based IDE at [platform.classiq.io](https://platform.classiq.io/) automatically updates.
Every few weeks a new version of the platform launches. The web-based IDE at [platform.classiq.io](https://platform.classiq.io/) automatically updates.

Update the Python SDK package manually with this command:

Expand Down
2 changes: 1 addition & 1 deletion .internal/docs/qmod-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Qmod description in Python can be translated to an equivalent in the native
syntax and vice versa. Each of these may appeal to different users in different situations.

The Qmod native syntax is designed to express the concepts of the language in a pure
and concise form. In addition, the Classiq platform features smart editor support
and concise form. In addition, the platform features smart editor support
for Qmod, which is tuned for the language syntax and semantics.

Users who feel comfortable programming in the Python language and environment, may
Expand Down
18 changes: 9 additions & 9 deletions .internal/docs/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Welcome to the Classiq Support Center. This page is designed to help you quickly
??? note "What is Classiq?"
Classiq is quantum-computing software that enables the design, optimization, analysis, and execution of quantum algorithms. Check out how to get started [here](/latest/getting-started/).

??? note "I'm new to the Classiq Platform—what are my first steps?"
- Start with [Registration and Installation](/latest/getting-started/registration_installations/) to get access to the Classiq Platform.
- [The Classiq Tutorial](/latest/getting-started/classiq_tutorial/) will help with your first steps in coding.
??? note "I'm new to the platform—what are my first steps?"
- Start with [Registration and Installation](/latest/getting-started/registration_installations/) to get access to the platform.
- [The Onboarding Tutorial](/latest/getting-started/classiq_tutorial/) will help with your first steps in coding.
- When you feel confident, try some of our [real-world applications](/latest/explore/applications/).

??? note "Can I execute algorithms on quantum computers using Classiq?"
Expand All @@ -32,21 +32,21 @@ Welcome to the Classiq Support Center. This page is designed to help you quickly
??? note "How can I fix `ClassiqAuthenticationError: Request to Auth0 failed with error code 403`?"
This error arises when your authentication credentials are denied. Try overriding your authentication credentials by executing `authenticate(overwrite=True)`.

??? note "My Classiq Studio cannot reconnect"
If you’re experiencing failed attempts to reconnect to Classiq Studio or long loading times, please try closing and reopening your web browser.
??? note "My Studio cannot reconnect"
If you’re experiencing failed attempts to reconnect to the Studio or long loading times, please try closing and reopening your web browser.

??? note "I'm having authentication problems in Classiq Studio"
??? note "I'm having authentication problems in the Studio"
Try authenticating again using:
[comment]: DO_NOT_TEST
```python
import classiq

classiq.authenticate()
```
To prevent such problems in the future, it is a good practice to begin code files in Studio with `authenticate()`.
To prevent such problems in the future, it is a good practice to begin code files in the Studio with `authenticate()`.

??? note "Example notebooks in Classiq Studio aren’t working"
Some example notebooks (e.g., chemistry) require additional packages in Classiq Studio. First, try:
??? note "Example notebooks in the Studio aren’t working"
Some example notebooks (e.g., chemistry) require additional packages in the Studio. First, try:

```bash
pip install "classiq[chemistry]"
Expand Down
10 changes: 5 additions & 5 deletions .internal/docs/user-guide/ai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ search:

We have architected our Classiq Library and SDK with enhanced AI agent compatibility, enabling AI agents to perform quantum development within integrated development environments. This supports AI-first IDEs like Cursor as well as VSCode with AI extensions like Cline and Claude Code, and other IDE-integrated AI coding assistants.

## Cline Agent in Classiq Studio
## AI Agent in The Studio

The Cline agent is now available directly within our Classiq Studio environment! This provides seamless AI-powered quantum development without any additional setup.
The AI agent is now available directly within our Studio environment! This provides seamless AI-powered quantum development without any additional setup.

### Quick Start

To start using the Cline agent in Studio:
To start using the AI Agent in the Studio:

1. **Set your API key**: Configure an API key for your preferred LLM provider (among those supported by Cline)
2. **Start coding**: The Cline agent will be ready to assist with quantum algorithm development using the Classiq SDK
1. **Set your API key**: Configure an API key for your preferred LLM provider (among those supported)
2. **Start coding**: The AI agent will be ready to assist with quantum algorithm development using the Classiq SDK

This integration allows you to leverage AI assistance for quantum programming directly within the Studio interface, making quantum development more accessible and efficient.

Expand Down
4 changes: 2 additions & 2 deletions .internal/docs/user-guide/analysis/automatic-registers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This feature completes the [manual](./quantum-program-visualization-tool/basic-v

## Introduction

Each function contains information on its registers, which is mainly provided by the Classiq synthesis engine.
Each function contains information on its registers, which is mainly provided by the synthesis engine.
The information includes the register type (input, output, zero, auxiliary), the name, and the qubits it contains.

You can get information about the function's registers by clicking the function and looking in the **Information**
Expand All @@ -29,7 +29,7 @@ Two or more wires can be merged only if:

## Input Registers

Currently, the Classiq platform only supports input registers. To see if a register is an input register, look in the **Information** tab.
Currently, the platform only supports input registers. To see if a register is an input register, look in the **Information** tab.

![Register info](../../resources/single_register_info.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The hardware analysis supplies two main insights.

To perform hardware-aware analysis, you may want to know which devices are
available using the
Classiq Platform. You can get a list of the devices that are both available and
platform. You can get a list of the devices that are both available and
suit the quantum program (i.e., have a sufficient number of qubits).

[comment]: DO_NOT_TEST
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are 3 ways to view a quantum program using the visualization tool:

- Direct access via the Classiq IDE

- Direct access via the Classiq Studio
- Direct access via the Studio

### Classiq Python SDK

Expand Down Expand Up @@ -46,7 +46,7 @@ show(qprog)

![upload_qp](../resources/upload_qp.gif)

### Visualization in the Classiq Studio
### Visualization in the Studio

- Follow the same steps as in Classiq Python SDK. The visualization tool can be directly rendered in the notebook:

Expand Down Expand Up @@ -125,7 +125,7 @@ In the example below, the Variables View shows a simplified implementation of th

### Sharing your Quantum Program Visualization

You can easily share your Quantum Program visualization with anyone, even those who haven’t signed up for the Classiq platform. It’s simple:
You can easily share your Quantum Program visualization with anyone, even those who haven’t signed up for the platform. It’s simple:

- Copy the Quantum Program URL directly from your browser and share it.
- Alternatively, click the "Share" button on the Quantum Program page, choose a social media to share in or copy the generated link, and share it with anyone.
Expand Down
4 changes: 2 additions & 2 deletions .internal/docs/user-guide/applications/optimization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ Read in-depth reviews of the language’s capabilities in
The basics of problem modelling in PYOMO and
a complete example are in the [problem formulation](problem-formulation.md) section.

The Classiq platform supports an extensive set of modeling configurations for your use ([supported modeling](supported-modeling.md)).
The platform supports an extensive set of modeling configurations for your use ([supported modeling](supported-modeling.md)).

## Solving Optimization Problems

The core Classiq capabilities are generation of a designated quantum solution,
and execution of the generated algorithm on a quantum backend.

The Classiq platform relies on the QAOA penalty algorithm to solve optimization problems.
The platform relies on the QAOA penalty algorithm to solve optimization problems.

## References

Expand Down
2 changes: 1 addition & 1 deletion .internal/docs/user-guide/applications/qml/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Quantum machine learning (QML) is a field that seeks to combine the principles o
quantum mechanics and machine learning to develop new algorithms and techniques that
can process and analyze data more efficiently.

The Classiq platform has a few QML built-in algorithms:
The platform has a few QML built-in algorithms:

- With [Quantum Neural Network (QNN)](qnn/index.md), you can combine classical and quantum neural network layers.
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Execution on Amazon Braket requires an AWS account, and a role that Classiq can

### Initial Account Setup

Before first use, the Classiq platform needs your permission to connect to your
Before first use, the platform needs your permission to connect to your
AWS account. This is done by creating a cross-account role.

Classiq provides with the attached CloudFormation `AssumeRole.cf.yaml` file. It only has the permissions needed for Braket.
Expand All @@ -68,7 +68,7 @@ To learn more about IAM roles, refer to the [AWS documentation](https://docs.aws

### Required Credentials

When executing via the Classiq platform using AWS Cloud, there are several
When executing via the platform using AWS Cloud, there are several
required credentials:

1. `aws_access_key_id`
Expand Down
2 changes: 1 addition & 1 deletion .internal/docs/user-guide/execution/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ search:

# Execution

The Classiq Platform allows you to execute quantum programs on quantum hardware or simulators of your choice.
The platform allows you to execute quantum programs on quantum hardware or simulators of your choice.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion .internal/docs/user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ search:

Welcome to the User Guide!

This section guides you through all the key features and functionalities of the Classiq platform.
This section guides you through all the key features and functionalities of the platform.
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ search:
boost: 3.116
---

# **Getting started with Classiq Studio**
# **Getting started with Studio**

This page contains a detailed guide on how to use the Classiq Studio.
This page contains a detailed guide on how to use the Studio.

## **Setup and get started**

To get started with the Classiq Studio, follow these steps:
To get started with the Studio, follow these steps:

1. Sign up to the Classiq platform: At https://platform.classiq.io/, click Sign Up. Approve the terms of use and register with your Google/Microsoft account or any other email (if needed fill in the registration form and you will be redirected to the home page).
2. Access the Classiq Studio from the Classiq Platform home page or site pane.
1. Sign up to the platform: At https://platform.classiq.io/, click Sign Up. Approve the terms of use and register with your Google/Microsoft account or any other email (if needed fill in the registration form and you will be redirected to the home page).
2. Access the Studio from the platform home page or site pane.
![platform home page](resources/StudioClickHere.png).

3. Your environment is loaded in a new browser tab (initial setup could take a couple of minutes). ![loading-page](resources/loading-page.png)
Expand All @@ -37,7 +37,7 @@ Your workspace consist of two sections:

## **Best practices**

In Classiq Studio each user has its own dedicated persistence storage (2 GB).
In the Studio each user has its own dedicated persistence storage (2 GB).
What does this even means? It means that every time you reload you can keep working right where you left off, same as working locally on your computer :)

There are several considerations and best practices it's better to keep in mind:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ search:

# **Getting started with git**

This page contains a practical guide on how to get started with git and GitHub, so you can get the most out of working with Classiq Studio and writing code in general
This page contains a practical guide on how to get started with git and GitHub, so you can get the most out of working with the Studio and writing code in general

## **what is git?**

Expand All @@ -26,7 +26,7 @@ We highly recommend to push your code to a remote repository. It will promise yo

## **Common commands and quick setup**

Classiq Studio comes with Git pre-installed, so you can start using it right away.
The Studio comes with Git pre-installed, so you can start using it right away.

### **Initialize a Git Repository**

Expand Down Expand Up @@ -128,9 +128,9 @@ git checkout -b feature-branch
- Use `.gitignore` – avoid committing unnecessary files.
- Create pull requests – review changes before merging into main.

## **How to use git in the Classiq Studio**
## **How to use git in the Studio**

- Open the terminal in the Classiq Studio.
- Open the terminal in the Studio.
- We have already installed git inside the studio, so you can start using it right away.

## **Read more**
Expand Down
Loading
Loading