Skip to content

Commit

Permalink
doc: Update readme. Change the docker image base to jupyter minimal
Browse files Browse the repository at this point in the history
  • Loading branch information
ShuxiangCao committed Mar 29, 2024
1 parent 63a7e5e commit 9b20eb8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM quay.io/jupyter/datascience-notebook
FROM quay.io/jupyter/minimal-notebook:latest

# Clone the repository from github
RUN git clone https://gitlab.com/LBL-QubiC/software.git /home/jovyan/packages/QubiC/software
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ on superconducting circuits-based quantum computing systems.

## Quick Start

### Docker image
To use the Docker image, run the following command:

```bash
docker run -p 8888:8888 -p 5000:5000 -v /path/to/local/folder:/home/jovyan/ ghcr.io/shuxiangcao/leeq:latest
```

Then, open the browser and go to `http://localhost:8888` to access the Jupyter notebook. The port 5000 is used for the
live plotting server. To mount the local folder, replace `/path/to/local/folder` with the path to the local folder.

### Tutorial

See the [Quick Start Guide](docs/quick_start.md) for a 10-minute guide to launch LeeQ. Or the [One-hour full tutorial tutorial](docs/tutorial.md).

A notebook example and configuration example are prepared in the [notebook](notebooks) folder.
Expand Down

0 comments on commit 9b20eb8

Please sign in to comment.