Skip to content

Commit 58e2c38

Browse files
Update docs
1 parent f1fb8b7 commit 58e2c38

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ![Open Quantum Design](docs/img/oqd-logo-text.png)
2-
![Python](https://img.shields.io/badge/Python-3.11-blue)
2+
3+
![Python](https://img.shields.io/badge/Python-3.10_|_3.11_|_3.12-blue)
4+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
35

46
<h2 align="center">
57
Open Quantum Design: Cloud

docs/index.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,35 @@
66
</h2>
77
</div>
88

9+
![Python](https://img.shields.io/badge/Python-3.10_|_3.11_|_3.12-blue)
910
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
10-
1111
<!-- prettier-ignore -->
1212
/// admonition | Note
1313
type: note
1414
Welcome to the Open Quantum Design.
1515
This documentation is still under development, we welcome contributions! © Open Quantum Design
1616
///
1717

18+
19+
## What's Here
20+
This repository contains the software needed to submit jobs to a remote, cloud server for classical simulations of quantum programs.
21+
In addition, it provides a Docker script to self-host a simulation server of the OQD emulator backends.
22+
23+
## Installation
24+
To install locally for development or launching a Docker container server:
25+
26+
```bash
27+
git clone https://github.com/OpenQuantumDesign/oqd-cloud.git
28+
pip install .
29+
```
30+
31+
To start the simulation server, ensure Docker is installed on the machine, navigate to the `docker` folder, and run,
32+
```bash
33+
docker compose up
34+
```
35+
36+
To serve the documentation,
37+
```bash
38+
pip install .[docs]
39+
mkdocs serve
40+
```

0 commit comments

Comments
 (0)