diff --git a/README.md b/README.md index 17ed2ab..e012d69 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,30 @@ 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"). -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: +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 VS Code-based IDEs. + +To run a locally installed notebook: ```bash jupyter notebook