@@ -53,10 +53,9 @@ <h1 class="title">Module <code>quera_ahs_utils.plotting</code></h1>
53
53
54
54
Args:
55
55
register (AtomArrangement): A given register
56
- blockade_radius (float): The blockade radius for the register. Default is 0
57
- what_to_draw (str): Either "bond" or "circle" to indicate the blockade region.
58
- Default is "bond"
59
- show_atom_index (bool): Whether showing the indices of the atoms. Default is True
56
+ blockade_radius (float): Default is 0. The blockade radius for the register.
57
+ what_to_draw (str): Default is "bond". Either "bond" or "circle" to indicate the blockade region.
58
+ show_atom_index (bool): Default is True. Whether showing the indices of the atoms.
60
59
61
60
"""
62
61
filled_sites = [site.coordinate for site in register if site.site_type == SiteType.FILLED]
@@ -91,7 +90,7 @@ <h1 class="title">Module <code>quera_ahs_utils.plotting</code></h1>
91
90
"""Plot the driving field
92
91
Args:
93
92
drive (DrivingField): The driving field to be plot
94
- axes: matplotlib axis to draw on
93
+ axes: Default is None. matplotlib axis to draw on
95
94
**plot_ops: options passed to matplitlib.pyplot.plot
96
95
"""
97
96
@@ -502,7 +501,7 @@ <h2 id="args">Args</h2>
502
501
< dt > < strong > < code > drive</ code > </ strong > : < code > DrivingField</ code > </ dt >
503
502
< dd > The driving field to be plot</ dd >
504
503
< dt > < strong > < code > axes</ code > </ strong > </ dt >
505
- < dd > matplotlib axis to draw on</ dd >
504
+ < dd > Default is None. matplotlib axis to draw on</ dd >
506
505
< dt > < strong > < code > **plot_ops</ code > </ strong > </ dt >
507
506
< dd > options passed to matplitlib.pyplot.plot</ dd >
508
507
</ dl > </ div >
@@ -514,7 +513,7 @@ <h2 id="args">Args</h2>
514
513
"""Plot the driving field
515
514
Args:
516
515
drive (DrivingField): The driving field to be plot
517
- axes: matplotlib axis to draw on
516
+ axes: Default is None. matplotlib axis to draw on
518
517
**plot_ops: options passed to matplitlib.pyplot.plot
519
518
"""
520
519
@@ -580,12 +579,11 @@ <h2 id="args">Args</h2>
580
579
< dt > < strong > < code > register</ code > </ strong > : < code > AtomArrangement</ code > </ dt >
581
580
< dd > A given register</ dd >
582
581
< dt > < strong > < code > blockade_radius</ code > </ strong > : < code > float</ code > </ dt >
583
- < dd > The blockade radius for the register. Default is 0 </ dd >
582
+ < dd > Default is 0. The blockade radius for the register.</ dd >
584
583
< dt > < strong > < code > what_to_draw</ code > </ strong > : < code > str</ code > </ dt >
585
- < dd > Either "bond" or "circle" to indicate the blockade region.
586
- Default is "bond"</ dd >
584
+ < dd > Default is "bond". Either "bond" or "circle" to indicate the blockade region. </ dd >
587
585
< dt > < strong > < code > show_atom_index</ code > </ strong > : < code > bool</ code > </ dt >
588
- < dd > Whether showing the indices of the atoms. Default is True </ dd >
586
+ < dd > Default is True. Whether showing the indices of the atoms.</ dd >
589
587
</ dl > </ div >
590
588
< details class ="source ">
591
589
< summary >
@@ -601,10 +599,9 @@ <h2 id="args">Args</h2>
601
599
602
600
Args:
603
601
register (AtomArrangement): A given register
604
- blockade_radius (float): The blockade radius for the register. Default is 0
605
- what_to_draw (str): Either "bond" or "circle" to indicate the blockade region.
606
- Default is "bond"
607
- show_atom_index (bool): Whether showing the indices of the atoms. Default is True
602
+ blockade_radius (float): Default is 0. The blockade radius for the register.
603
+ what_to_draw (str): Default is "bond". Either "bond" or "circle" to indicate the blockade region.
604
+ show_atom_index (bool): Default is True. Whether showing the indices of the atoms.
608
605
609
606
"""
610
607
filled_sites = [site.coordinate for site in register if site.site_type == SiteType.FILLED]
0 commit comments