Skip to content

Commit

Permalink
Merge pull request #16 from JoelPasvolsky/leap_ide
Browse files Browse the repository at this point in the history
Update readme for IDE
  • Loading branch information
JoelPasvolsky authored Oct 30, 2023
2 parents 95ff1ce + 8218b5c commit cf37c16
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,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/anneal-schedule-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-anneal-schedule.ipynb`` file in VS Code-based IDEs.

To run a locally installed notebook:

```bash
jupyter notebook
Expand Down

0 comments on commit cf37c16

Please sign in to comment.