From 6202e6ba310759f0f11cbcdd89be69f88ca06656 Mon Sep 17 00:00:00 2001 From: Joel Pasvolsky Date: Thu, 26 Oct 2023 14:58:47 -0700 Subject: [PATCH 1/2] Switch to supported IDEs --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 17ed2ab..b3d4322 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ -[![Open in Leap IDE]( - https://cdn-assets.cloud.dwavesys.com/shared/latest/badges/leapide.svg)]( - https://ide.dwavesys.io/#https://github.com/dwave-examples/reverse-annealing-notebook) [![Linux/Mac/Windows build status]( https://circleci.com/gh/dwave-examples/reverse-annealing-notebook.svg?style=shield)]( https://circleci.com/gh/dwave-examples/reverse-annealing-notebook) @@ -30,16 +27,25 @@ The notebook has the following sections: ## Installation -You can run this example -[in the Leap IDE](https://ide.dwavesys.io/#https://github.com/dwave-examples/reverse-annealing-notebook). +You can run this example without installation in cloud-based IDEs that support +the [Development Containers specification](https://containers.dev/supporting) +(aka "devcontainers") such as [GitHub Codespaces](https://docs.github.com/codespaces). -Alternatively, install requirements locally (ideally, in a virtual environment): +For development environments that do not support ``devcontainers``, install +requirements: pip install -r requirements.txt +If you are cloning the repo to your local system, working in a +[virtual environment](https://docs.python.org/3/library/venv.html) is +recommended. + ## Usage -To run the notebook: +The notebook can be opened by clicking on the +``01-reverse-annealing.ipynb`` file in Codespaces. + +To run a locally installed notebook: ```bash jupyter notebook From bbd15e3928679673d74fe1ba2d8ea7b4d5ea8463 Mon Sep 17 00:00:00 2001 From: Joel Pasvolsky Date: Mon, 30 Oct 2023 10:22:08 -0700 Subject: [PATCH 2/2] Minor edits --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3d4322..e012d69 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ The notebook has the following sections: You can run this example without installation in cloud-based IDEs that support the [Development Containers specification](https://containers.dev/supporting) -(aka "devcontainers") such as [GitHub Codespaces](https://docs.github.com/codespaces). +(aka "devcontainers"). For development environments that do not support ``devcontainers``, install requirements: @@ -42,8 +42,13 @@ recommended. ## Usage +Your development environment should be configured to +[access Leap’s Solvers](https://docs.ocean.dwavesys.com/en/stable/overview/sapi.html). +You can see information about supported IDEs and authorizing access to your +Leap account [here](https://docs.dwavesys.com/docs/latest/doc_leap_dev_env.html). + The notebook can be opened by clicking on the -``01-reverse-annealing.ipynb`` file in Codespaces. +``01-reverse-annealing.ipynb`` file in VS Code-based IDEs. To run a locally installed notebook: