running linter

Author: weinbe58

docs/home/background.md

@@ -10,7 +10,7 @@ For a more nuanced and in-depth read about the neutral atoms that Bloqade and *A
 
 ## Analog vs Digital Quantum Computing
 
-There are two modes of quantum computation that [neutral atoms](#neutral-atom-qubits) are capable of: [*Analog*](#analog-mode) and [*Digital*](#digital-mode). 
+There are two modes of quantum computation that [neutral atoms](#neutral-atom-qubits) are capable of: [*Analog*](#analog-mode) and [*Digital*](#digital-mode).
 
 You can find a brief explanation of the distinction below but for a more in-depth explanation you can refer to QuEra's qBook section on [Analog vs Digital Quantum Computing](https://qbook.quera.com/learn/?course=6630211af30e7d0013c66147&file=6630211af30e7d0013c6614a)
 
@@ -46,11 +46,11 @@ The [Rydberg Many-Body Hamiltonian](#rydberg-many-body-hamiltonian) already impl
 They are a sum of one or more *spatial modulations*, which allows you to *scale* the amplitude of the waveform across the different sites in the system:
 
 $$
-F_{i}(t) = \sum_{\alpha} C_{i}^{\alpha}f_{\alpha}(t) 
+F_{i}(t) = \sum_{\alpha} C_{i}^{\alpha}f_{\alpha}(t)
 $$
 
 $$
-C_{i}^{\alpha} \in \mathbb{R} 
+C_{i}^{\alpha} \in \mathbb{R}
 $$
 
 $$
@@ -64,6 +64,5 @@ Note that the drive is only applied if the $i$-th site is filled with an atom.
 You build fields in Bloqade by first specifying the spatial modulation followed by the waveform
 it should be multiplied by.
 
-In the case of a *uniform* spatial modulation, it can be interpreted as 
+In the case of a *uniform* spatial modulation, it can be interpreted as
 a constant scaling factor where $C_{i}^{\alpha} = 1.0$.
-

docs/home/emulation.md

@@ -1,3 +1,3 @@
 # Emulation
 
-This page is a work in progress!
+This page is a work in progress!

docs/home/geometry.md

@@ -1,3 +1,3 @@
 # Geometry
 
-This page is a work in progress!
+This page is a work in progress!

docs/home/quick_start.md

@@ -1,6 +1,6 @@
 # Quick Start
 
-All the sections below are self-contained, you can click on the links in the Table of Contents to read the relevant parts. 
+All the sections below are self-contained, you can click on the links in the Table of Contents to read the relevant parts.
 
 ## Navigating the Bloqade API
 
@@ -18,7 +18,7 @@ The same goes for [JetBrains PyCharm](https://www.jetbrains.com/pycharm/):
 
 ![PyCharm Hints](../assets/quick_start/pycharm-hints.gif)
 
-### Jupyter Notebook 
+### Jupyter Notebook
 
 In a [Jupyter Notebook](https://jupyter.org/) you'll need to type `.` and then hit tab for the hints to appear:
 
@@ -85,7 +85,7 @@ After you've [defined a geometry](#defining-atom-geometry) you:
 * Specify `detuning`, `rabi.amplitude` or `rabi.phase`
 * Specify the [spatial modulation][local-control]
 
-Which then leads you to the ability to specify a waveform of interest and begin constructing your pulse sequence. 
+Which then leads you to the ability to specify a waveform of interest and begin constructing your pulse sequence.
 In the example below, we target the ground-Rydberg level coupling to drive with uniform [spatial modulation][local-control] for the Rabi amplitude. Our waveform is a piecewise linear one which ramps from $0$ to $5 \,\text{rad/us}$, holds that value for $1 \,\text{us}$ and then ramps back down to $0 \,\text{rad/us}$.
 
 ```python
@@ -120,7 +120,7 @@ from math import sin
 geometry = start.add_position((0,0))
 target_rabi_amplitude = geometry.rydberg.rabi.amplitude.uniform
 
-def custom_waveform(t): 
+def custom_waveform(t):
     return 2.0 * sin(t)
 
 custom_waveform_applied = (
@@ -129,7 +129,7 @@ custom_waveform_applied = (
 )
 ```
 
-In this form you can immediately [emulate](#emulation) it if you'd like but to run this on [hardware](#submitting-to-hardware) you need to discretize it. The waveform on hardware has to either be: 
+In this form you can immediately [emulate](#emulation) it if you'd like but to run this on [hardware](#submitting-to-hardware) you need to discretize it. The waveform on hardware has to either be:
 
 * Piecewise linear for Rabi amplitude and detuning terms of the Hamiltonian
 * Piecewise constant for the Phase term of the Hamiltonian
@@ -146,7 +146,7 @@ custom_discretized_waveform_applied = (
 
 !!! note
 
-    Programs that have custom functions as waveforms are not fully serializable. This means that when you are [saving and reloading results](#saving-and-loading-results), the original embedded program will be missing that custom waveform. You will still be able to analyze the saved results! 
+    Programs that have custom functions as waveforms are not fully serializable. This means that when you are [saving and reloading results](#saving-and-loading-results), the original embedded program will be missing that custom waveform. You will still be able to analyze the saved results!
 
 
 ## Slicing and Recording Waveforms
@@ -173,7 +173,7 @@ vars_assigned_program = sliced_program.batch_assign(run_time=run_times)
 
 This program will run fine in [emulation](#emulation) but due to hardware constraints certain waveforms (such as those targeting the Rabi Amplitude), the waveform needs to start and end at $0 \,\text{rad}/\text{us}$. Thus, there needs to be a way to slice our waveform but also add an end component to that waveform. `.record` in Bloqade lets you literally "record" the value at the end of a `.slice` and then use it to construct further parts of the waveform.
 
-In the program below the waveform is still sliced but with the help of `.record` a linear segment that pulls the waveform down to $0.0 \,\text{rad}/\text{us}$ from whatever its current value at the slice is in $0.7 \,\text{us}$ is added. 
+In the program below the waveform is still sliced but with the help of `.record` a linear segment that pulls the waveform down to $0.0 \,\text{rad}/\text{us}$ from whatever its current value at the slice is in $0.7 \,\text{us}$ is added.
 
 ```python
 from bloqade import start
@@ -219,7 +219,7 @@ pulse_sequence.show()
 And when you're content with it you just `.apply()` it on the geometries of your choice:
 
 ```python
-from bloqade.atom_arrangement import Honeycomb, Kagome 
+from bloqade.atom_arrangement import Honeycomb, Kagome
 
 geometry_1 = Honeycomb(2, lattice_spacing = 6.0)
 geometry_2 = Kagome(2, lattice_spacing = 6.0)
@@ -318,7 +318,7 @@ report.rydberg_densities()
 ```
 ```
                  0      1
-task_number              
+task_number
 0            0.053  0.054
 ```
 
@@ -334,7 +334,7 @@ report.show()
 
 ## Parameter Sweeps
 
-You can easily do parameter sweeps in emulation and on *Aquila* with variables. Bloqade automatically detects strings in your program as variables that you can later assign singular or multiple values to. 
+You can easily do parameter sweeps in emulation and on *Aquila* with variables. Bloqade automatically detects strings in your program as variables that you can later assign singular or multiple values to.
 
 In the example below, we define a program with a singular variable that controls the amplitude of the waveform.
 
@@ -344,7 +344,7 @@ from bloqade import start
 rabi_oscillations_program = (
     start.add_position((0, 0))
     .rydberg.rabi.amplitude.uniform.piecewise_linear(
-        durations=[0.06, 3, 0.06], 
+        durations=[0.06, 3, 0.06],
         values=[0, "rabi_amplitude", "rabi_amplitude", 0]
     )
 )
@@ -374,7 +374,7 @@ delayed_assignment_program = rabi_oscillations_program.args(["rabi_amplitude"])
 results = delayed_assignment_program.bloqade.python().run(100, args=(1.0,))
 ```
 
-You can alternatively treat the program as a callable after using `.args()` (note the inverted order of arguments in the call!): 
+You can alternatively treat the program as a callable after using `.args()` (note the inverted order of arguments in the call!):
 
 ```python
 delayed_assignment_program = rabi_oscillations_program.args(["rabi_amplitude"])
@@ -400,18 +400,18 @@ geometry = start.add_position((0,0))
 target_rabi_amplitude = geometry.rydberg.rabi.amplitude.uniform
 rabi_waveform = (
     target_rabi_amplitude
-    .piecewise_linear(durations=waveform_durations, 
+    .piecewise_linear(durations=waveform_durations,
                       values=[0.0, my_var, my_var, 0.0])
 )
 target_detuning = rabi_waveform.detuning.uniform
 detuning_waveform = (
     target_detuning
-    .piecewise_linear(durations=waveform_durations, 
+    .piecewise_linear(durations=waveform_durations,
                       values=[my_var-1.0, my_var*0.5, my_var/2, my_var+1.0 ])
 )
 ```
 
-You still perform variable assignment just like you normally would: 
+You still perform variable assignment just like you normally would:
 
 ```python
 program = detuning_waveform.assign(my_variable=1.0)
@@ -428,7 +428,7 @@ geometry = start.add_position((0,0))
 target_rabi_amplitude = geometry.rydberg.rabi.amplitude.uniform
 rabi_waveform = (
     target_rabi_amplitude
-    .piecewise_linear(durations=variable_durations, 
+    .piecewise_linear(durations=variable_durations,
                       values=[0.0, 1.5, 1.5, 0.0])
 )
 target_detuning = rabi_waveform.detuning.uniform
@@ -456,8 +456,8 @@ your_program = ...
 emulation_results = your_program.bloqade.python().run(100)
 hardware_results = your_program.braket.aquila.run_async(100)
 
-save(emulation_results, "emulation_results.json") 
-save(hardware_results, "hardware_results.json") 
+save(emulation_results, "emulation_results.json")
+save(hardware_results, "hardware_results.json")
 ```
 
 And later reload them into Python using the `load` function:
@@ -469,4 +469,4 @@ hardware_results = load("hardware_results.json")
 ```
 
 [local-control]: background.md#local-control
-[rydberg-hamiltonian]: background.md#rydberg-many-body-hamiltonian
+[rydberg-hamiltonian]: background.md#rydberg-many-body-hamiltonian

docs/home/submission.md

@@ -1,3 +1,3 @@
 # Submission
 
-This page is a work in progress!
+This page is a work in progress!

docs/home/visualization.md

@@ -1,3 +1,3 @@
 # Visualization
 
-This page is a work in progress!
+This page is a work in progress!

docs/home/waveforms.md

@@ -1,3 +1,3 @@
 # Waveforms
 
-This page is a work in progress!
+This page is a work in progress!

docs/index.md

@@ -36,7 +36,7 @@ from bloqade.atom_arrangement import Honeycomb
 geometry = Honeycomb(2, lattice_spacing = 10.0)
 ```
 
-We can verify what the atom geometry looks like by `.show()`'ing it: 
+We can verify what the atom geometry looks like by `.show()`'ing it:
 
 ```python
 geometry.show()
@@ -60,7 +60,7 @@ rabi_program = (
 )
 ```
 <!--explain what uniform is-->
-Here `rabi.amplitude` means exactly what it is, the Rabi amplitude term of the [Hamiltonian][rydberg-hamiltonian]. `uniform` refers to applying the waveform uniformly across all the atom locations. 
+Here `rabi.amplitude` means exactly what it is, the Rabi amplitude term of the [Hamiltonian][rydberg-hamiltonian]. `uniform` refers to applying the waveform uniformly across all the atom locations.
 
 We can visualize what our program looks like again with `.show()`:
 
@@ -88,7 +88,7 @@ Which gives us:
 [OrderedDict([('0', 55), ('1', 45)])]
 ```
 
-If we want to submit our program to hardware we'll need to adjust the waveform as there is a constraint the Rabi amplitude waveform must start and end at zero. 
+If we want to submit our program to hardware we'll need to adjust the waveform as there is a constraint the Rabi amplitude waveform must start and end at zero.
 This is easy to do as we can build off the atom geometry we saved previously but apply a piecewise linear waveform:
 
 ```python
@@ -106,8 +106,8 @@ hardware_rabi_program.show()
 </picture>
 </div>
 
-Now instead of using the built-in Bloqade emulator we submit the program to *Aquila*. You will need to use the [AWS CLI](https://aws.amazon.com/cli/) to obtain credentials from your AWS account 
-or set the proper environment variables before hand. 
+Now instead of using the built-in Bloqade emulator we submit the program to *Aquila*. You will need to use the [AWS CLI](https://aws.amazon.com/cli/) to obtain credentials from your AWS account
+or set the proper environment variables before hand.
 
 ```python
 hardware_results = hardware_rabi_program.braket.aquila.run_async(100)
@@ -133,7 +133,7 @@ rabi_program = (
   .rydberg.rabi.amplitude.uniform
   .constant(value=pi/2, duration=1.0)
 )
-emulation_results = rabi_program.bloqade.python().run(100) 
+emulation_results = rabi_program.bloqade.python().run(100)
 bitstring_counts = emulation_results.report().counts()
 
 hardware_rabi_program = (
@@ -151,7 +151,7 @@ hardware_bitstring_counts = hardware_results.report().counts()
 ## Features
 
 
-### Customizable Atom Geometries 
+### Customizable Atom Geometries
 
 You can easily explore a number of common geometric lattices with Bloqade's `atom_arrangement`'s:
 
@@ -256,7 +256,7 @@ hardware_results = rabi_oscillation_job.braket.aquila().run(100)
 ```
 emulation_results.report().rydberg_densities()
                 0
-task_number      
+task_number
 0            0.16
 1            0.35
 2            0.59
@@ -303,4 +303,4 @@ Bloqade is released under the [Apache License, Version 2.0](https://github.com/Q
 
 [rabi-oscillation-wiki]: https://en.wikipedia.org/wiki/Rabi_cycle
 [neutral-atom-qubits]: home/background.md#neutral-atom-qubits
-[rydberg-hamiltonian]: home/background.md#rydberg-many-body-hamiltonian
+[rydberg-hamiltonian]: home/background.md#rydberg-many-body-hamiltonian

docs/scripts/gen_ref_nav.py

@@ -4,7 +4,6 @@
 
 import mkdocs_gen_files
 
-
 SRC_PATH = "src"
 
 skip_keywords = [

src/bloqade/analog/__init__.py

@@ -3,22 +3,27 @@
 except ImportError:
     __path__ = __import__("pkgutil").extend_path(__path__, __name__)
 
-from bloqade.analog.ir import var, cast, Variable, Literal, start
-from bloqade.analog.ir import to_waveform as waveform
-from bloqade.analog.serialize import load, save, loads, dumps
+import importlib.metadata
 
+import bloqade.analog.ir as _ir
+from bloqade.analog.ir import (
+    Literal,
+    Variable,
+    var,
+    cast,
+    start,
+    to_waveform as waveform,
+)
 from bloqade.analog.factory import (
-    get_capabilities,
-    piecewise_linear,
-    piecewise_constant,
     linear,
     constant,
     rydberg_h,
+    get_capabilities,
+    piecewise_linear,
+    piecewise_constant,
 )
-import bloqade.analog.ir as _ir
 from bloqade.analog.constants import RB_C6
-
-import importlib.metadata
+from bloqade.analog.serialize import load, save, dumps, loads
 
 __version__ = importlib.metadata.version("bloqade-analog")