Skip to content

Atom arrangement

AtomArrangement

Bases: ProgramStart, TransformTrait

n_atoms property 

n_atoms

number of atoms (filled sites) in the register.

n_dims property 

n_dims

number of dimensions in the register.

n_sites property 

n_sites

number of sites in the register.

n_vacant property 

n_vacant

number of vacant sites in the register.

enumerate 

enumerate()

enumerate all locations in the register.

Source code in src/bloqade/ir/location/base.py 
106
107
108
def enumerate(self) -> Generator[LocationInfo, None, None]:
    """enumerate all locations in the register."""
    raise NotImplementedError

figure 

figure(fig_kwargs=None, **assignments)

obtain a figure object from the atom arrangement.

Source code in src/bloqade/ir/location/base.py 
110
111
112
def figure(self, fig_kwargs=None, **assignments):
    """obtain a figure object from the atom arrangement."""
    return get_atom_arrangement_figure(self, fig_kwargs, **assignments)

rydberg_interaction 

rydberg_interaction(**assignments)

calculate the Rydberg interaction matrix.

Parameters:

Name Type Description Default
**assignments

the values to assign to the variables in the register.

 {}

Returns:

Name Type Description
NDArray NDArray

the Rydberg interaction matrix in the lower triangular form.
Source code in src/bloqade/ir/location/base.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def rydberg_interaction(self, **assignments) -> NDArray:
    """calculate the Rydberg interaction matrix.

    Args:
        **assignments: the values to assign to the variables in the register.

    Returns:
        NDArray: the Rydberg interaction matrix in the lower triangular form.

    """

    from bloqade.constants import RB_C6

    # calculate the Interaction matrix
    V_ij = np.zeros((self.n_sites, self.n_sites))
    for i, site_i in enumerate(self.enumerate()):
        pos_i = np.array([float(ele(**assignments)) for ele in site_i.position])

        for j, site_j in enumerate(self.enumerate()):
            if j >= i:
                break  # enforce lower triangular form

            pos_j = np.array([float(ele(**assignments)) for ele in site_j.position])
            r_ij = np.linalg.norm(pos_i - pos_j)

            V_ij[i, j] = RB_C6 / r_ij**6

    return V_ij

Chain 

Chain(L, lattice_spacing=1.0, vertical_chain=False)

Bases: BoundedBravais

Chain lattice.

  • 1D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0).
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
L int

number of sites in the chain

 required
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
193
194
195
196
197
198
@beartype
def __init__(
    self, L: int, lattice_spacing: ScalarType = 1.0, vertical_chain: bool = False
):
    self.vertical = vertical_chain
    super().__init__(L, lattice_spacing=lattice_spacing)

Honeycomb 

Honeycomb(L1, L2=None, lattice_spacing=1.0)

Bases: BoundedBravais

Honeycomb lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (2 atom(s))
    • loc1 (0, 0)
    • loc2 (½, 1/(2*sqrt(3))

Parameters:

Name Type Description Default
L1 int

number of unit cells in linear direction. n_atoms = L1 * L1 * 2.

 required
L2 Optional[int]

number of unit cells in direction a2. n_atoms = L1 * L2 * 2, default is L1.

 None
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
390
391
392
393
394
395
396
@beartype
def __init__(
    self, L1: int, L2: Optional[int] = None, lattice_spacing: ScalarType = 1.0
):
    if L2 is None:
        L2 = L1
    super().__init__(L1, L2, lattice_spacing=lattice_spacing)

Kagome 

Kagome(L1, L2=None, lattice_spacing=1.0)

Bases: BoundedBravais

Kagome lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (3 atom(s))
    • loc1 (0, 0)
    • loc2 (0.5, 0)
    • loc3 (0.25 ,0.25sqrt(3))

Parameters:

Name Type Description Default
L1 int

number of sites in linear direction. n_atoms = 3 * L1 * L1.

 required
L2 Optional[int]

number of unit cells along a2 direction, n_atoms = 3 * L1 * L2, default is L1.

 None
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
524
525
526
527
528
529
530
@beartype
def __init__(
    self, L1: int, L2: Optional[int] = None, lattice_spacing: ScalarType = 1.0
):
    if L2 is None:
        L2 = L1
    super().__init__(L1, L2, lattice_spacing=lattice_spacing)

Lieb 

Lieb(L1, L2=None, lattice_spacing=1.0)

Bases: BoundedBravais

Lieb lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (0, 1)
  • unit cell (3 atom(s))
    • loc1 (0, 0)
    • loc2 (0.5, 0)
    • loc3 (0 ,0.5)

Parameters:

Name Type Description Default
L1 int

number of unit cells in linear direction. n_atoms = 3* L1 * L1.

 required
L2 Optional[int]

number of unit cells along a2 direction, n_atoms = 3 * L1 * L2, default is L1.

 None
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
479
480
481
482
483
484
485
@beartype
def __init__(
    self, L1: int, L2: Optional[int] = None, lattice_spacing: ScalarType = 1.0
):
    if L2 is None:
        L2 = L1
    super().__init__(L1, L2, lattice_spacing=lattice_spacing)

Rectangular 

Rectangular(
    width,
    height,
    lattice_spacing_x=1.0,
    lattice_spacing_y=None,
)

Bases: BoundedBravais

Rectangular lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0)
    • a2 = (0,1)
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
width int

number of sites in x direction.

 required
height int

number of sites in y direction.

 required
lattice_spacing_x (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
lattice_spacing_y (Scalar, Real)

lattice spacing in y direction. optional.

 None
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
@beartype
def __init__(
    self,
    width: int,
    height: int,
    lattice_spacing_x: ScalarType = 1.0,
    lattice_spacing_y: Optional[ScalarType] = None,
):
    super().__init__(width, height, lattice_spacing=lattice_spacing_x)

    if lattice_spacing_y is None:
        self.ratio = cast(1.0) / cast(lattice_spacing_x)
    else:
        self.ratio = cast(lattice_spacing_y) / cast(lattice_spacing_x)

    super().__init__(width, height, lattice_spacing=lattice_spacing_x)

Square 

Square(L1, L2=None, lattice_spacing=1.0)

Bases: BoundedBravais

Square lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1,0)
    • a2 = (0,1)
  • unit cell (1 atom(s))
    • loc (0,0)

Parameters:

Name Type Description Default
L1 int

number of sites in linear direction. n_atoms = L1 * L1.

 required
L2 Optional[int]

number of sites in direction a2. n_atoms = L1 * L2, default is L1

 None
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
237
238
239
240
241
242
243
@beartype
def __init__(
    self, L1: int, L2: Optional[int] = None, lattice_spacing: ScalarType = 1.0
):
    if L2 is None:
        L2 = L1
    super().__init__(L1, L2, lattice_spacing=lattice_spacing)

Triangular 

Triangular(L1, L2=None, lattice_spacing=1.0)

Bases: BoundedBravais

Triangular lattice.

  • 2D lattice
  • primitive (cell) vector(s)
    • a1 = (1, 0)
    • a2 = (½, sqrt(3)/2)
  • unit cell (1 atom(s))
    • loc (0, 0)

Parameters:

Name Type Description Default
L int

number of sites in linear direction. n_atoms = L * L.

 required
L2 Optional[int]

number of sites along a2 direction, n_atoms = L1 * L2, default is L1.

 None
lattice_spacing (Scalar, Real)

lattice spacing. Defaults to 1.0.

 1.0
  • Possible Next: continue with . to see possible next step in auto-prompt supported setting (IPython, IDE ...)
Source code in src/bloqade/ir/location/bravais.py 
434
435
436
437
438
439
440
@beartype
def __init__(
    self, L1: int, L2: Optional[int] = None, lattice_spacing: ScalarType = 1.0
):
    if L2 is None:
        L2 = L1
    super().__init__(L1, L2, lattice_spacing=lattice_spacing)