Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rigetti/forest-notebook

Interactive quantum programming with Forest & Jupyter.
https://github.com/rigetti/forest-notebook

docker jupyter-notebook quantum-computing quantum-programming

Last synced: about 2 months ago
JSON representation

Interactive quantum programming with Forest & Jupyter.

Awesome Lists containing this project

README 

        
Interactive quantum programming with Forest & Jupyter

=====================================================



[![Binder](https://mybinder.org/badge_logo.svg)][binder]

[![docker pulls][docker-badge]][forest-notebook]

[![github release][github-badge]][github-release]



The `forest-notebook` repository contains the [`Dockerfile`][dockerfile]

for building the [`rigetti/forest-notebook`][forest-notebook] image.

This image contains an interactive quantum programming environment

backed by [JupyterLab][jupyter], akin to the applications available

in the [Docker Stacks][docker-stacks] repository.



The image is based off of the [`rigetti/forest`][forest] image, which comes

with [pyQuil][pyquil] installed, as well as [quilc][quilc] and [QVM][qvm]

servers running in the background. The `rigetti/forest-notebook` image

additionally has the [`forest-benchmarking`][benchmarking] library installed,

along with some useful Python packages for data analysis and visualization.

Finally, it contains `jupyter` and the new JupyterLab interface, and is

configured to spin up a notebook server when the image is run, which can

be done via the following command (optionally changing `PORT` to `localhost`

port you'd like to run the notebook server on):



```bash

PORT=8888 docker run -p $PORT:8888 rigetti/forest-notebook

```



This will start the container, and somewhere in the terminal output it will

print a URL that looks something like the following, but with `TOKEN` replaced

with a long string of letters and numbers:



```

http://127.0.0.1:8888/?token=TOKEN

```



Copy paste the above URL into your browser, replacing 8888 with `PORT`. This

will bring up the JupyterLab interface, with the root directory of the

filesystem being the top-level directory of the pyQuil repository. You can

then run the notebooks in the `examples` directory, or create your own.

These notebooks will have access to the latest quilc and QVM servers,

which are running in the background. Happy quantum programming!



Creating a Binder repository using this image

---------------------------------------------



One of the most exciting recent applications of a Jupyter-backed Docker

image is [Binder][mybinder], which provides a free hosting service and

executable environment for a repository of Jupyter notebooks. Binder can

be configured many ways, but the most advanced configuration is via a custom

Dockerfile. To create a Binder that has access to the full Forest quantum

programming suite, add the following Dockerfile to the repository of Jupyter

notebooks that you'd like to turn into an interactive web application:



```dockerfile

# build image from a tagged forest-notebook image

FROM rigetti/forest-notebook:3.0.0



# copy over files from binder repository into $HOME

COPY . ${HOME}



# set working directory to $HOME

WORKDIR ${HOME}

```



Once you've added the Dockerfile, follow the instructions in the Binder link

above to create your very own interactive quantum programming environment!



For some examples of existing Forest-backed Binder repositories, check out the following:



- [`rigetti/forest-tutorials`][forest-tutorials]:

    Interactive tutorial notebooks for pyQuil and the Forest quantum programming SDK.

- [`rigetti/qcs-paper`][qcs-paper]:

    Supplementary interactive notebooks from the [paper][arxiv] on Quantum Cloud Services.

- [`karalekas/stanford-cs269q`][stanford-cs269q]:

    Lecture notebook from Stanford's course on quantum computer programming.

- [`exeter-quantum/senior-project`][exeter]:

    Notebooks from a quantum computing senior project at Phillips Exeter Academy.



[arxiv]: https://arxiv.org/abs/2001.04449

[benchmarking]: https://github.com/rigetti/forest-benchmarking

[binder]: https://mybinder.org/v2/gh/rigetti/forest-tutorials/master?urlpath=lab/tree/Welcome.ipynb

[dockerfile]: https://docs.docker.com/engine/reference/builder/

[docker-badge]: https://img.shields.io/docker/pulls/rigetti/forest-notebook.svg

[docker-stacks]: https://github.com/jupyter/docker-stacks

[exeter]: https://github.com/exeter-quantum/senior-project

[forest]: https://hub.docker.com/r/rigetti/forest

[forest-notebook]: https://hub.docker.com/r/rigetti/forest-notebook

[forest-tutorials]: https://github.com/rigetti/forest-tutorials

[github-badge]: https://img.shields.io/github/release/rigetti/forest-notebook.svg

[github-release]: https://github.com/rigetti/forest-notebook/releases

[gitlab-badge]: https://gitlab.com/rigetti/forest/forest-notebook/badges/master/pipeline.svg

[gitlab-project]: https://gitlab.com/rigetti/forest/forest-notebook/commits/master

[jupyter]: https://jupyter.org/

[mybinder]: https://mybinder.org

[pyquil]: https://github.com/rigetti/pyquil

[qcs-paper]: https://github.com/rigetti/qcs-paper

[quilc]: https://github.com/rigetti/quilc

[qvm]: https://github.com/rigetti/qvm

[stanford-cs269q]: https://github.com/karalekas/stanford-cs269q