czbloch:0.1.0 (typst#4297)

Author: Peng-Rao

packages/preview/czbloch/0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Víctor Ibáñez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/preview/czbloch/0.1.0/README.md

@@ -0,0 +1,104 @@
+# czbloch
+
+Draw Bloch spheres in Typst with configurable state vectors, axes, angle annotations, and sphere styles.
+
+![Examples](example.jpg)
+
+## Quick Start
+
+```typst
+#import "@preview/czbloch:0.1.0"
+
+#set page(width: auto, height: auto, margin: 8pt)
+
+= Basic States
+
+#stack(
+	dir: ltr,
+	spacing: 16pt,
+	czbloch.bloch(..czbloch.zero),
+	czbloch.bloch(..czbloch.one),
+	czbloch.bloch(..czbloch.plus),
+	czbloch.bloch(..czbloch.minus),
+)
+```
+
+## API
+
+### `bloch(...)`
+
+Main drawing function.
+
+```typst
+#czbloch.bloch(
+	length: 2cm,
+	radius: 1,
+	debug: false,
+	padding: none,
+	show-axis: true,
+	phi: 0deg,
+	theta: 0deg,
+	state-color: rgb("#ae3fee"),
+	sphere-style: "circle",
+	angle-labels: true,
+	polar-labels: true,
+)
+```
+
+Parameters:
+
+- `length`: Final rendered canvas size.
+- `radius`: Logical radius of the Bloch sphere inside the canvas.
+- `debug`: Enables CeTZ debug rendering.
+- `padding`: CeTZ canvas padding.
+- `show-axis`: Draw Cartesian axes and labels.
+- `phi`: Azimuthal angle of the state vector.
+- `theta`: Polar angle of the state vector.
+- `state-color`: Stroke/fill color for the state arrow.
+- `sphere-style`: `"circle"`, `"sphere"`, or `none`.
+- `angle-labels`: Show `phi` and `theta` labels.
+- `polar-labels`: Show `|0>` and `|1>` pole labels.
+
+### Presets
+
+Useful preset states exported by the package:
+
+- `czbloch.zero`: `(phi: 0deg, theta: 0deg)`
+- `czbloch.one`: `(phi: 0deg, theta: 180deg)`
+- `czbloch.plus`: `(phi: 0deg, theta: 90deg)`
+- `czbloch.minus`: `(phi: 180deg, theta: 90deg)`
+
+Use with argument spread:
+
+```typst
+#czbloch.bloch(..czbloch.plus, state-color: green)
+```
+
+## More Examples
+
+```typst
+#import "@preview/czbloch:0.1.0" as czbloch
+
+#stack(
+	dir: ttb,
+	spacing: 12pt,
+
+	// Sphere-style shading
+	czbloch.bloch(..czbloch.one, sphere-style: "sphere"),
+
+	// Custom state
+	czbloch.bloch(
+		phi: 50deg,
+		theta: 30deg,
+		state-color: orange,
+		angle-labels: false,
+	),
+
+	// Wrapped angles are supported
+	czbloch.bloch(
+		phi: -10deg,
+		theta: 240deg,
+		sphere-style: "sphere",
+	),
+)
+```

packages/preview/czbloch/0.1.0/example.jpg

@@ -0,0 +1,44 @@
+#import "@preview/czbloch:0.1.0" as czbloch
+
+#set page(margin: 0.1cm, height: auto, width: auto)
+
+#let opts-1 = (angle-labels: false)
+#let opts-2 = (angle-labels: false, sphere-style: "sphere")
+
+#let examples = (
+  (czbloch.bloch(state-color: red), `czbloch.bloch(state-color: red)`),
+  (
+    czbloch.bloch(..czbloch.one, sphere-style: "sphere"),
+    `czbloch.bloch(.., sphere-style: "sphere")`,
+  ),
+  (
+    czbloch.bloch(..czbloch.plus, ..opts-2, state-color: lime),
+    `czbloch.bloch(.., angle-labels: false)`,
+  ),
+  (
+    czbloch.bloch(..czbloch.minus, ..opts-1, state-color: fuchsia),
+    none,
+  ),
+  (
+    czbloch.bloch(phi: 50deg, theta: 30deg, ..opts-1, state-color: green),
+    none,
+  ),
+  (
+    czbloch.bloch(phi: -10deg, theta: 120deg, ..opts-2, state-color: orange),
+    `czbloch.bloch(phi: -100deg, theta: 120deg, ..)`,
+  ),
+)
+
+#set align(center)
+
+#for pair in examples.chunks(2) {
+  let drawings = pair.map(d => d.at(0))
+  let code = pair.map(d => d.at(1))
+  table(
+    stroke: none,
+    columns: 2,
+    column-gutter: 0.5cm,
+    ..drawings,
+    ..code
+  )
+}