Skip to content

Commit 0cc14f6

Browse files
[update] Update pyproject.toml and README for packaging
1 parent c5f26bf commit 0cc14f6

2 files changed

Lines changed: 30 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
1-
# ![Open Quantum Design](docs/img/oqd-logo-text.png)
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)
1+
# ![Open Quantum Design](https://raw.githubusercontent.com/OpenQuantumDesign/oqd-compiler-infrastructure/main/docs/img/oqd-logo-text.png)
52

63
<h2 align="center">
74
Open Quantum Design: Cloud
85
</h2>
96

7+
[![doc](https://img.shields.io/badge/documentation-lightblue)](https://docs.openquantumdesign.org/open-quantum-design-cloud)
8+
[![PyPI Version](https://img.shields.io/pypi/v/oqd-cloud)](https://pypi.org/project/oqd-cloud)
9+
[![CI](https://github.com/OpenQuantumDesign/oqd-cloud/actions/workflows/pytest.yml/badge.svg)](https://github.com/OpenQuantumDesign/oqd-cloud/actions/workflows/pytest.yml)
10+
![versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
11+
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
12+
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)
13+
14+
15+
1016
## What's Here
1117
This repository contains the software needed to submit jobs to a remote, cloud server for classical simulations of quantum programs.
1218
In addition, it provides a Docker script to self-host a simulation server of the OQD emulator backends.
1319

1420
## Installation
21+
```bash
22+
pip install oqd-cloud
23+
```
24+
1525
To install locally for development or launching a Docker container server:
1626

1727
```bash
@@ -21,7 +31,8 @@ pip install .
2131

2232
To start the simulation server, ensure Docker is installed on the machine, navigate to the `docker` folder, and run,
2333
```bash
24-
docker compose up
34+
cd oqd-cloud/docker
35+
docker compose up -d
2536
```
2637

2738
To serve the documentation,

pyproject.toml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ build-backend = "setuptools.build_meta"
55

66
[project]
77
name = "oqd-cloud"
8-
version = "0.0.0"
8+
version = "0.1.0"
99
requires-python = ">=3.10"
1010
readme = "README.md"
11-
license = { file = "LICENSE" }
11+
license = {text = "Apache 2.0"}
1212
keywords = ["quantum", "computing", "simulation", "cloud", "server"]
1313
classifiers = [
1414
"Development Status :: 3 - Alpha",
@@ -26,7 +26,14 @@ classifiers = [
2626
]
2727

2828

29-
dependencies = ["requests", "pydantic>=2.4", "numpy~=1.0"]
29+
dependencies = [
30+
"requests",
31+
"pydantic>=2.4",
32+
"numpy~=1.0",
33+
"oqd-compiler-infrastructure",
34+
"oqd-core",
35+
"oqd-analog-emulator"
36+
]
3037

3138
[project.optional-dependencies]
3239
docs = [
@@ -46,9 +53,10 @@ server = [
4653
"python-jose",
4754
"passlib",
4855
"python-multipart",
49-
"oqd_compiler_infrastructure@git+https://github.com/openquantumdesign/oqd-compiler-infrastructure",
50-
"oqd_core@git+https://github.com/openquantumdesign/oqd-core",
51-
"oqd_analog_emulator@git+https://github.com/openquantumdesign/oqd-analog-emulator",
56+
#
57+
"oqd-compiler-infrastructure",
58+
"oqd-core",
59+
"oqd-analog-emulator",
5260
]
5361

5462

0 commit comments

Comments
 (0)