Set up a Q# standalone environment
Learn how to configure a standalone Q# development environment using Jupyter Notebooks, Visual Studio Code (VS Code), Visual Studio, or any editor/IDE. Q# programs can run on their own, or can utilize a driver program in a host language like C# or F#.
Q# and Jupyter Notebooks
Jupyter Notebooks allows running code in-place alongside instructions, notes, and other content. This environment is ideal for writing Q# code with embedded explanations or quantum computing interactive tutorials. All the necessary components can be set up with a single conda installation.
If you want to use Jupyter Notebooks but prefer not to install conda, you can set up Jupyter Notebooks with the .NET CLI.
Initialize conda for your preferred shell with the
conda initcommand. The steps below are tailored to your operating system:
(Windows) Open an Anaconda Prompt by searching for it in the start menu. Then run the initialization command for your shell, for example,
conda init powershell cmd.exewill set up both the Windows PowerShell and Command Prompt for you. You can then close this prompt.
To work with PowerShell, conda will configure a startup script to run whenever you launch a PowerShell instance. By default, the script's execution will be blocked on Windows, and requires modifying the PowerShell execution policy with the following command (executed from within PowerShell):
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
(Linux) If haven't done so during installation, you can still initialize conda now. Open a terminal and navigate to the
bindirectory inside your selected install location (for example,
/home/ubuntu/miniconda3/bin). Then run the appropriate command for your shell, for example,
./conda init bash. Close your terminal for the changes to take effect.
From a new terminal, create and activate a new conda environment named
qsharp-envwith the required packages (including Jupyter Notebook and IQ#) by running the following commands:
conda create -n qsharp-env -c microsoft qsharp notebook conda activate qsharp-env
python -c "import qsharp"to verify your installation and populate your local package cache with all required QDK components.
Q# and other IDEs
While you can build Q# applications in any IDE, we recommend using Visual Studio Code (VS Code) or Visual Studio IDE for developing your Q# applications if you are running them via a .NET console. Developing in these environments leverages the rich functionality of the Quantum Development Kit (QDK) extension, which includes warnings, syntax highlighting, project templates, and more.
Configure the QDK for your preferred environment from one of the following options:
- Download and install VS Code 1.52.0 or greater (Windows, Linux and Mac).
- Install the QDK for VS Code.
If you are a Arm-based Mac user, make sure you install .NET SDK 6.0 or greater, as older versions are not supported on this architecture.
Visual Studio (Windows only)
- Download and install Visual Studio 17.0 or greater, with the .NET Core cross-platform development workload enabled.
- Download and install the QDK.
Although there is Visual Studio for Mac, the QDK extension is only compatible with Visual Studio for Windows.
Jupyter Notebooks (using the .NET CLI)
If you want to run your programs in Jupyter Notebooks but don't want to install conda, you can set up the necessary components with .NET.
Install IQ# via the .NET
dotnet tool install -g Microsoft.Quantum.IQSharp dotnet iqsharp install
If you encounter a permission error in Linux, install the IQ# kernel in user mode instead with
dotnet iqsharp install --user.
If you encounter an error and you just installed .NET, you won't be able to run the
dotnet iqsharp installcommand immediately. Instead, under Windows, open a new terminal window and try again. Under Linux, log out of your session and log back in to try again. If this still doesn't work, try locating the installed
dotnet-iqsharptool (on Windows,
dotnet-iqsharp.exe) and running:
/path/to/dotnet-iqsharp install --user --path-to-tool="/path/to/dotnet-iqsharp"
/path/to/dotnet-iqsharpshould be replaced by the absolute path to the
dotnet-iqsharptool in your file system. Typically this will be under
.dotnet/toolsin your user profile folder.
- Enter the following at the command prompt
dotnet new -i Microsoft.Quantum.ProjectTemplates
Azure CLI (.NET Core SDK 3.1 not required)
Install the Azure CLI.
Install the Azure CLI
quantumextension. Open a command prompt and run the following command:
az extension add --upgrade -n quantum
Submit and view feedback for