Skip to content

Commit

Permalink
Merge pull request #14 from JoelPasvolsky/leap_ide
Browse files Browse the repository at this point in the history
Switch to supported IDEs
  • Loading branch information
randomir authored Oct 31, 2023
2 parents edfa1e0 + bbd15e3 commit ce7b156
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ce7b156

Please sign in to comment.