{"id":18565277,"url":"https://github.com/rigetti/forest-tutorials","last_synced_at":"2025-10-07T21:01:40.285Z","repository":{"id":44606139,"uuid":"236209112","full_name":"rigetti/forest-tutorials","owner":"rigetti","description":"Binder repository of interactive tutorial notebooks for pyQuil and Forest.","archived":false,"fork":false,"pushed_at":"2022-02-05T04:04:24.000Z","size":927,"stargazers_count":28,"open_issues_count":2,"forks_count":16,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-10T18:57:33.923Z","etag":null,"topics":["binder","docker","jupyter-notebook","quantum-computing"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rigetti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-25T18:09:10.000Z","updated_at":"2024-12-15T12:47:59.000Z","dependencies_parsed_at":"2022-09-13T13:51:33.567Z","dependency_job_id":null,"html_url":"https://github.com/rigetti/forest-tutorials","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/rigetti/forest-tutorials","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fforest-tutorials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fforest-tutorials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fforest-tutorials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fforest-tutorials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rigetti","download_url":"https://codeload.github.com/rigetti/forest-tutorials/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fforest-tutorials/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278846344,"owners_count":26056090,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["binder","docker","jupyter-notebook","quantum-computing"],"created_at":"2024-11-06T22:18:10.779Z","updated_at":"2025-10-07T21:01:40.269Z","avatar_url":"https://github.com/rigetti.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"Interactive tutorial notebooks for pyQuil and Forest\n====================================================\n\n[![Binder](https://mybinder.org/badge_logo.svg)][binder]\n[![docker pulls][docker-badge]][docker-image]\n[![github release][github-badge]][github-release]\n\nThis is a Binder repository containing tutorial notebooks for learning about [pyQuil][pyquil] and\nthe Forest SDK ([quilc][quilc] and the [QVM][qvm]). If you'd like to add a notebook, or change an\nexisting one, make a pull request! And, to run the existing notebooks in a preconfigured environment\non Binder, click the badge above!\n\nAlternatively, you can run the image locally with the following command (replacing `PORT`\nwith the `localhost` port you'd like to run the notebook server on):\n\n```bash\ndocker run -p PORT:8888 rigetti/forest-tutorials\n```\n\nThis will start the container, and somewhere in the terminal output it will print a URL that\nlooks something like the following, but with `TOKEN` replaced with a long string of letters\nand numbers:\n\n```\nhttp://127.0.0.1:8888/?token=TOKEN\n```\n\nCopy paste the above URL into your browser, replacing 8888 with `PORT`. This will bring up the\nJupyterLab interface.\n\nRunning the notebooks without using Docker\n------------------------------------------\n\nWe recommend using the Binder link above, or following the Docker-based instructions, if all\nyou want to do is run the notebooks. This is because it requires no setup on your end (except\nfor maybe [installing Docker][docker-docs]). However, if you'd like to run the notebooks locally\nwithout Docker, or if you'd like to make a pull request and contribute your own tutorial, you'll\nhave to set up a Python environment with the necessary requirements installed. Normally, these are\ndefined in a `requirements.txt` file, but adding one to this repo would cause Binder to use that\nfor its configuration instead of the `Dockerfile`.\n\nThus, run the following command in your Python environment to install all the necessary\nrequirements:\n\n```bash\npip install pyquil jupyterlab matplotlib pandas forest-benchmarking\n```\n\nThen, assuming you've cloned this repository and you're in its top-level directory, running\n`jupyter lab` should be all you need to get started!\n\nContributing your own tutorial notebook\n---------------------------------------\n\nAs mentioned above, if you'd like to contribute your own tutorial, or improve an existing one,\nyou can make a pull request to this repository. If you add a\nnotebook that depends on a third-party library and is not currently installed in the\n[`rigetti/forest-notebook`][forest-notebook] Docker image (see the next section for more info),\nyou will have to add the requirement to this document.\n\nBuilding your own Forest-backed Binder repository\n-------------------------------------------------\n\nThis Binder repository is built using the [`rigetti/forest-notebook`][forest-notebook] Docker\nimage, which comes with [pyQuil][pyquil] installed, as well as [quilc][quilc] and [QVM][qvm]\nservers running in the background. It additionally has the [`forest-benchmarking`][benchmarking]\nlibrary installed, along with some useful Python packages for data analysis and visualization.\nYou can create your own Binder repository from this image by following the directions at the\nbottom of the README of the [rigetti/forest-notebook][forest-notebook-repo] repository!\n\n[arxiv]: https://arxiv.org/abs/2001.04449\n[benchmarking]: https://github.com/rigetti/forest-benchmarking\n[binder]: https://mybinder.org/v2/gh/rigetti/forest-tutorials/master?urlpath=lab/tree/Welcome.ipynb\n[docker-badge]: https://img.shields.io/docker/pulls/rigetti/forest-tutorials.svg\n[docker-docs]: https://docs.docker.com/\n[docker-image]: https://hub.docker.com/r/rigetti/forest-tutorials\n[forest-notebook]: https://hub.docker.com/r/rigetti/forest-notebook\n[forest-notebook-repo]: https://github.com/rigetti/forest-notebook\n[github-badge]: https://img.shields.io/github/v/release/rigetti/forest-tutorials\n[github-release]: https://github.com/rigetti/forest-tutorials/releases\n[gitlab-badge]: https://gitlab.com/rigetti/forest/forest-tutorials/badges/master/pipeline.svg\n[gitlab-project]: https://gitlab.com/rigetti/forest/forest-tutorials/commits/master\n[pyquil]: https://github.com/rigetti/pyquil\n[pyquil-setup]: https://github.com/rigetti/pyquil/blob/master/setup.py\n[qvm]: https://github.com/quil-lang/qvm\n[quilc]: https://github.com/quil-lang/quilc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fforest-tutorials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frigetti%2Fforest-tutorials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fforest-tutorials/lists"}