merging definitions of add_positions and add_positions (#591)

* adding dispatch of `add_position` to list as well as numpy array.

* bump minor version.

* fixing readme.

* Update philosophy.md

* adding back beartype checks

* removing `singledispatchmethod` because it create a property not a method.

* updating docs.

* adding test for assertion error.

README.md

@@ -36,7 +36,7 @@ calculation = (
 ```
 
 From here there will be different methods and properties that you can use to build your program. For example,
-you can start to add atom sites to your program by selecting `add_position` method or `add_positions` method.
+you can start to add atom sites to your program by selecting `add_position`.
 
 ```python
 from bloqade import start
@@ -45,7 +45,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
 )
 ```
 
@@ -58,7 +58,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg
 )
 ```
@@ -73,7 +73,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning
 )
 ```
@@ -88,7 +88,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform
 )
 ```
@@ -103,7 +103,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],
@@ -121,7 +121,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],
@@ -149,7 +149,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],
@@ -176,7 +176,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],
@@ -208,7 +208,7 @@ program = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],

docs/docs/getting_started/philosophy.md

@@ -10,7 +10,7 @@ calculation = (
 ```
 
 From here there will be different methods and properties that you can use to build your program. For example,
-you can start to add atom sites to your program by selecting `add_position` method or `add_positions` method.
+you can start to add atom sites to your program by selecting `add_position` method.
 
 ```python
 from bloqade import start
@@ -19,7 +19,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
 )
 ```
 
@@ -32,7 +32,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg
 )
 ```
@@ -47,7 +47,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning
 )
 ```
@@ -62,7 +62,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform
 )
 ```
@@ -77,7 +77,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0 0.1],
@@ -95,7 +95,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0 0.1],
@@ -123,7 +123,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0 0.1],
@@ -150,7 +150,7 @@ calculation = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0 0.1],
@@ -182,7 +182,7 @@ program = (
     start
     .add_position((0, 0))
     .add_position((0, 6.8))
-    .add_positions([(6.8, 0), (6.8, 6.8)])
+    .add_position([(6.8, 0), (6.8, 6.8)])
     .rydberg.detuning.uniform.
     piecewise_linear(
         durations = [0.1, 1.0, 0.1],

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bloqade"
-version = "0.3.7"
+version = "0.4.7"
 description = "Neutral atom software development kit"
 authors = [
     {name = "QuEra Computing Inc.", email = "info@quera.com"},

src/bloqade/builder/field.py

@@ -37,7 +37,7 @@ def uniform(self):
             - Addressing rydberg detuning to all atoms in the system with
             4 sites
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.uniform
 
         """
@@ -59,13 +59,13 @@ def location(self, label: int):
 
             - Addressing rydberg detuning to location 1 on a system with 4 sites.
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(1)
 
             - Addressing rydberg detuning on both location
             0 and 2 on a system with 4 sites.
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(1).location(2)
 
         Note:
@@ -142,7 +142,7 @@ def var(self, name: str):
             - Addressing rydberg detuning to atom location `myatom` in the system with
             4 sites
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.var('myatom')
 
         """

src/bloqade/builder/pragmas.py

@@ -32,7 +32,7 @@ def assign(self, **assignments) -> "Assign":
             and 0.5 to the variable "span_time".
 
             >>> reg = bloqade.start
-            ...       .add_positions([(0,0),(1,1),(2,2),(3,3)])
+            ...       .add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> seq = reg.rydberg.detuning.uniform
             ...       .linear(start="ival",stop=1,duration="span_time")
             >>> seq = seq.assign(span_time = 0.5, ival = 0.0)
@@ -65,7 +65,7 @@ def parallelize(self, cluster_spacing: ScalarType) -> Parallelize:
             - Parallelize the current problem with cluster spacing 7.2 um.
 
             >>> prob = (
-                    bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+                    bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
                     .rydberg.detuning.uniform
                     .linear(start=0,stop=1,duration=1)
                     )

src/bloqade/builder/spatial.py

@@ -23,13 +23,13 @@ class Uniform(SpatialModulation):
 
         - To hit this node from the start node:
 
-        >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+        >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
         >>> loc = reg.rydberg.detuning.uniform
 
         - Apply Linear waveform:
 
         >>> wv = bloqade.ir.Linear(start=0,stop=1,duration=0.5)
-        >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+        >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
         >>> loc = reg.rydberg.detuning.uniform.apply(wv)
 
     """
@@ -61,13 +61,13 @@ def location(self, label: int) -> "Location":
 
             - Append location 1 to the current location 0.
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(0)
             >>> loc = loc.location(1)
 
             - One can keep appending by concatenating location()
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(0)
             >>> loc = loc.location(1).location(2)
 
@@ -120,19 +120,19 @@ def scale(self, value: ScalarType) -> "Scale":
 
             - Scale the preceeding waveform that addressing location(0) by 1.2.
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> scaled = reg.rydberg.detuning.location(0).scale(1.2)
 
             - Scale multiple locations with different factors.
             (ex. loc 0 by 1.2, loc 1 by 0.5)
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(0)
             >>> loc = loc.scale(1.2).location(1).scale(0.5)
 
             - Scale multiple locations with the same factor. (ex. loc 0 and 1 by 1.2)
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> scaled = reg.rydberg.detuning.location(0).location(1).scale(1.2)
 
 
@@ -192,7 +192,7 @@ def location(self, label: int) -> "Location":
 
             - Append location 1 after scale location 0 by 1.2.
 
-            >>> reg = bloqade.start.add_positions([(0,0),(1,1),(2,2),(3,3)])
+            >>> reg = bloqade.start.add_position([(0,0),(1,1),(2,2),(3,3)])
             >>> loc = reg.rydberg.detuning.location(0).scale(1.2)
             >>> loc = loc.location(1)