Registration and Installation
In order to use Classiq, one must register to the Classiq platform, where it is available for free for non-commercial use. After registering to the platform, one can also install the Python SDK package and authenticate their account. In the following we will guide you through both steps.
Registration
First, go to platform.classiq.io and press the Sign Up button. Then, after approving the terms of use, you can register with your Google/Microsoft accounts, or with any other email:
Then a screen with further information needs to be filed:
And upon completion, you will be moved to the home page of the Classiq platform and the registration has been completed.
Slack Registration
Classiq has a vibrant and active Slack community that is really helpful for technical questions and support, as well as for general quantum computing questions and discussions. In order to join our Slack Community, press here and sign up to the Classiq Community Slack workspace with your Google/Apple account or with a general email:
Python SDK Installation
The Classiq platform has an accompanied Python SDK package that is integrated with the Classiq platform. After registering to the platform, one can install the SDK package.
NOTE - The SDK is currently supported for Python versions 3.8 to 3.11.
The package should be installed using pip with:
pip install -U classiq
Once the package is installed, the device being used should be authenticated with your Classiq account. In Python, execute the following two lines:
import classiq
classiq.authenticate()
A confirmation window is then opened in your web browser and you should confirm the authentication:
Once you receive a confirmation you are good to go!
If you encounter an issue, look for a solution in the troubleshooting section or ask in our community Slack.
Platform Version Updates
Every few weeks a new version of the Classiq platform is launched. The web-based IDE at platform.classiq.io is automatically updated. The Python SDK package should be updated manually with the command:
pip install -U classiq
In order to update the Python SDK for a specific version, you should run in the terminal the following:
pip install classiq=={DESIRED_VERSION}
and replace the DESIRED_VERSION with the number of your desired version, e.g. 0.40. You can check what version of Classiq is installed with:
pip show classiq
NOTE - At any point, only the last 3 versions of Classiq are supported. E.g., if the current version is 0.41, so only versions 0.41, 0.40 and 0.39 are supported. You can check the Active Classiq Versions page for more information.
Python SDK Installation Troubleshooting
Device is not Authenticated
Try to use the following command from your Python:import classiq
classiq.authenticate(overwrite=True)
Authentication on Headless LINUX Systems
The authentication procedure on headless Linux systems stores the tokens locally in a credentials file. While you must still run the authentication once, it can be done on another system with a browser.Confidential Information Pop Up on Apple computers
In some Apple computers, the following might pop-up: