# Install Locally Follow the steps below to use the [Quil SDK](/qcs/master.md#quil-sdk) locally. {% hint style="info" %} Installing locally is most useful for development using a QVM. Running programs against a QPU requires a [reservation](/qcs/guides/access-a-qpu/reserving-time-on-a-qpu.md) as well as network access to the QPU (available via your provisioned [JupyterLab IDE](/qcs/getting-started/set-up-your-environment/jupyterlab-ide.md)). {% endhint %} ## Install the Compiler and QVM Start by [downloading the `quilc` and `qvm` binaries](https://qcs.rigetti.com/sdk-downloads) for your operating system. {% hint style="success" %} If you'd like to skip installing `quilc` and `qvm` locally, you can run them from pre-created [Docker](https://www.docker.com/products/docker-desktop) images instead. For example: ```bash docker run --rm -it -p 5555:5555 rigetti/quilc -P -S ``` ```bash docker run --rm -it -p 5000:5000 rigetti/qvm -S ``` {% endhint %} {% hint style="info" %} If you want to avoid installing anything locally, you can use Docker to run a pre-built image with the entirety of the Quil SDK and JupyterLab pre-installed. See [Quil SDK Docker Image](/qcs/getting-started/set-up-your-environment/installing-locally/forest-docker-image.md)for setup instructions. {% endhint %} Start by [downloading the `quilc` and `qvm` binaries](https://qcs.rigetti.com/sdk-downloads) for your operating system. Then, follow the instructions for your platform to install them:
macOS To install on macOS, double-click `forest-sdk.dmg` once it's downloaded. Then double-click `forest-sdk.pkg` and follow the on-screen instructions. *** To uninstall, remove the following files: * `/usr/local/bin/qvm` * `/usr/local/bin/quilc` * `/usr/local/share/man/man1/qvm.1` * `/usr/local/share/man/man1/quilc.1`
Windows To install on Windows, double-click `forest-sdk.msi` once it's downloaded, then follow the on-screen instructions. *** * Use the Windows search bar to search for "Add or remove programs" * Uninstall the application named "Forest SDK for Windows"
Linux There are three ways to install on Linux: [deb](/qcs/getting-started/set-up-your-environment/installing-locally.md#deb), [rpm](/qcs/getting-started/set-up-your-environment/installing-locally.md#rpm), or [bare-bones](/qcs/getting-started/set-up-your-environment/installing-locally.md#bare-bones). #### deb Unpack the downloaded tarball and change to its resulting directory by running the following in a terminal (replacing `` with the downloaded version of the SDK): ```bash tar -xf forest-sdk-linux-deb.tar.bz2 cd forest-sdk--linux-deb ``` From here, run the following command to complete the install (replacing `` with the downloaded version of the SDK): ```bash sudo ./forest-sdk--linux-deb.run ``` When you're finished, move on to [verify the installation](/qcs/getting-started/set-up-your-environment/installing-locally.md#verify-installation). *** To uninstall, run: ```bash sudo apt remove forest-sdk ``` #### rpm Unpack the downloaded tarball and change to its resulting directory by running the following in a terminal (replacing `` with the downloaded version of the SDK): ```bash tar -xf forest-sdk-linux-rpm.tar.bz2 cd forest-sdk--linux-rpm ``` From here, run the following command to complete the install (replacing `` with the downloaded version of the SDK): ```bash sudo ./forest-sdk--linux-rpm.run ``` When you're finished, move on to [verify the installation](/qcs/getting-started/set-up-your-environment/installing-locally.md#verify-installation). *** To uninstall, run: ```bash sudo yum uninstall forest-sdk ``` or ```bash sudo rpm -e forest-sdk ``` #### bare-bones The bare-bones installation only contains the executable binaries and manual pages — it doesn’t contain any of the requisite dynamic libraries. As such, installation doesn’t require administrative or `sudo` privileges. First, unpack the downloaded tarball and change to its resulting directory by running the following in a terminal (replacing `` with the downloaded version of the SDK): ```bash tar -xf forest-sdk-linux-barebones.tar.bz2 cd forest-sdk--linux-barebones ``` From here, run the following command to complete the install (replacing `` with the downloaded version of the SDK): ```bash ./forest-sdk--linux-barebones.run ``` Upon successful installation, this will have created a new directory `rigetti` in your home directory that contains all of the binary and documentation artifacts. This method of installation requires you, through any means, to install shared libraries for `BLAS`, `LAPACK`, and `libffi`. On a Debian-derivative system, this could be accomplished with: ```bash sudo apt-get install liblapack-dev libblas-dev libffi-dev libzmq3-dev ``` Or on any rhel-derivative systems (e.g. Amazon Linux) with: ```bash sudo yum install -y lapack-devel blas-devel epel-release sudo yum install -y zeromq3-devel ``` *** To uninstall, remove the `~/rigetti` directory.
### Verify Installation To check that the binaries were properly installed, run the following commands in a terminal. They should each execute successfully and print version numbers. ```bash quilc --version qvm --version ``` ## Install pyQuil We publish new versions of pyQuil to [PyPI](https://pypi.org/project/pyquil). You can install pyQuil just like any other PyPI package. {% hint style="warning" %} pyQuil requires Python 3.8 or greater. {% endhint %} Using `pip`: ```bash pip install pyquil ``` Using `poetry`: ```bash poetry install pyquil ``` {% hint style="info" %} If you'd like to install pyQuil from source, see the [pyQuil GitHub repository](https://github.com/rigetti/pyquil). {% endhint %} ### Using a Virtual Environment We highly recommend installing into a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments). For example, you can create a virtual environment named `.venv` and activate it with the following command prior to installing pyQuil or other packages: ``` python -m venv .venv source .venv/bin/activate ``` {% hint style="info" %} To deactivate the virtual environment, run: ``` deactivate ``` {% endhint %} ## Start the Compiler and QVM Open a terminal window and start the compiler in server mode: ```bash quilc -P -S ``` Then, open a second terminal window and start the QVM in server mode: ```bash qvm -S ``` {% hint style="info" %} For more details on using the `quilc` and `qvm` binaries, see the [quilc Reference](/qcs/references/quilc.md) and the [QVM Reference](/qcs/references/qvm.md). {% endhint %} ## Run a Program Now that the compiler and QVM servers are running, you are ready to [run your first program with pyQuil](https://pyquil-docs.rigetti.com/en/stable/getting_started.html#run-your-first-program)! --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.rigetti.com/qcs/getting-started/set-up-your-environment/installing-locally.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.