Skip to content

Commit

Permalink
Add short description and simplify readme for pypi.
Browse files Browse the repository at this point in the history
  • Loading branch information
cqc-alec committed Jan 24, 2024
1 parent 4e0fb58 commit e0adc52
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[tool.poetry]
name = "guppylang"
version = "0.1.0"
description = ""
description = "Pythonic quantum-classical programming language"
authors = ["Mark Koch <[email protected]>"]
license = "Apache-2.0"
readme = "README.md"
readme = "quickstart.md"
repository = "https://github.com/CQCL/guppy"

[tool.poetry.dependencies]
Expand Down
24 changes: 24 additions & 0 deletions quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Guppy is a quantum programming language that is fully embedded into Python. It
allows you to write high-level hybrid quantum programs with classical control
flow and mid-circuit measurements using Pythonic syntax:

```python
from guppylang import guppy, Qubit, quantum

guppy.load(quantum)

# Teleports the state in `src` to `tgt`.
@guppy
def teleport(src: Qubit, tgt: Qubit) -> Qubit:
# Create ancilla and entangle it with src and tgt
tmp = Qubit()
tmp, tgt = cx(h(tmp), tgt)
src, tmp = cx(src, tmp)

# Apply classical corrections
if measure(h(src)):
tgt = z(tgt)
if measure(tmp):
tgt = x(tgt)
return tgt
```

0 comments on commit e0adc52

Please sign in to comment.