Skip to content

Commit

Permalink
[docs] update guide, readme, package
Browse files Browse the repository at this point in the history
  • Loading branch information
Mc-Zen committed Mar 11, 2024
1 parent ab43516 commit 7ec2f83
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">
<img alt="Quantum Circuit" src="docs/images/logo.svg" style="max-width: 100%; width: 300pt">
<img alt="Quill" src="docs/images/logo.svg" style="max-width: 100%; width: 300pt">
</h1>


Expand Down Expand Up @@ -29,7 +29,7 @@ Create circuit diagrams by calling the function `quantum-circuit()` with any num

```typ
#{
import "@preview/quill:0.2.0": *
import "@preview/quill:0.2.1": *
quantum-circuit(
lstick($|0〉$), $H$, ctrl(1), rstick($(|00〉+|11〉)/√2$, n: 2), [\ ],
Expand Down Expand Up @@ -72,6 +72,16 @@ This package uses [typst-test](https://github.com/tingerrr/typst-test/) for runn
## Changelog


### v0.2.1
- Improvements:
- Add `fill` parameter to `midstick()`.
- Add `bend` parameter to `permute()`.
- Add `separation` parameter to `permute()`.
- Fixes:
- With Typst 0.11.0, `scale()` now takes into account outer alignment. This broke the positioning of centered/right-aligned circuits, e.g., ones put into a `figure()`.
- Change wires to be drawn all through `ctrl()`, making it consistent to `swap()` and `targ()`.


### v0.2.0
- New features:
- Add arbitrary labels to any `gate` (also derived gates such as `meter`, `ctrl`, ...), `gategroup` or `slice` that can be anchored to any of the nine 2d alignments.
Expand Down
Binary file modified docs/guide/quill-guide.pdf
Binary file not shown.
5 changes: 3 additions & 2 deletions docs/guide/quill-guide.typ
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
title: "Guide for the Quill Package ",
authors: ("Mc-Zen",),
abstract: [Quill is a library for creating quantum circuit diagrams in #link("https://typst.app/", [Typst]). ],
date: "September 27, 2023",
date: "March 11, 2023",
version: version,
url: "https://github.com/Mc-Zen/quill"
)
Expand Down Expand Up @@ -524,6 +524,7 @@ All built-in gates are drawn with a dedicated `draw-function` and you can also t
first-heading-level: 2,
show-outline: false
)
let show-outline = tidy.styles.default.show-outline
let docs = parse-module(read("/src/quill.typ"))
let docs-gates = parse-module(read("/src/gates.typ"))
Expand Down Expand Up @@ -571,7 +572,7 @@ Circuit for performing the quantum Fourier transform, reproducing the Figure 5.1
== Shor Nine Qubit Code
Encoding circuit for the Shor nine qubit code. This diagram repdoduces Figure 10.4 in @nielsen_2022_quantum
Encoding circuit for the Shor nine qubit code. This diagram reproduces Figure 10.4 in @nielsen_2022_quantum
#table(columns: (2fr, 1fr), align: horizon, stroke: none,
block(raw({
Expand Down
2 changes: 1 addition & 1 deletion typst.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "quill"
version = "0.2.0"
version = "0.2.1"
entrypoint = "src/quill.typ"
authors = ["Mc-Zen"]
license = "MIT"
Expand Down

0 comments on commit 7ec2f83

Please sign in to comment.