sqdtoolz 0.9.0.dev1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (233) hide show
  1. sqdtoolz-0.9.0.dev1/LICENSE +203 -0
  2. sqdtoolz-0.9.0.dev1/PKG-INFO +125 -0
  3. sqdtoolz-0.9.0.dev1/README.md +95 -0
  4. sqdtoolz-0.9.0.dev1/pyproject.toml +64 -0
  5. sqdtoolz-0.9.0.dev1/setup.cfg +4 -0
  6. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/ACQ_ETH_FPGA.py +509 -0
  7. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/ACQ_M4i_Digitiser.py +397 -0
  8. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/ACQ_TektronixDSA70804B.py +775 -0
  9. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/ATTEN_Vaunix.py +106 -0
  10. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/AWG5014C.py +296 -0
  11. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Agilent_N8241A.py +1797 -0
  12. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/DDG_DG645.py +232 -0
  13. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/DSO_DS1054Z.py +426 -0
  14. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Agilent_N8241A_constants_python3.py +794 -0
  15. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/PrologixGPIBEthernet.py +65 -0
  16. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/RPi_gpio_interface.py +91 -0
  17. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/RPi_serial_interface.py +82 -0
  18. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/M4i.py +1380 -0
  19. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/__init__.py +0 -0
  20. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/py_header/__init__.py +0 -0
  21. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/py_header/regs.py +2863 -0
  22. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/py_header/spcerr.py +81 -0
  23. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/Spectrum/pyspcm.py +245 -0
  24. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/teproteus.py +977 -0
  25. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Dependencies/tevisainst.py +498 -0
  26. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/FGEN_FY6900.py +234 -0
  27. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/MWS_SGS100A.py +203 -0
  28. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/MWS_SMB100A.py +274 -0
  29. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/MWS_WFSynthHDProV2.py +222 -0
  30. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/MWS_WFSynthHDProV2_RPi.py +56 -0
  31. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SA_RS_FSV.py +246 -0
  32. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SMU_B2901A.py +226 -0
  33. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SMU_Keithley236.py +404 -0
  34. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SMU_TENMA_72_2710.py +192 -0
  35. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_BJT_RPi.py +87 -0
  36. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_BJT_RPi_Multi.py +107 -0
  37. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_FPGA_VNA.py +114 -0
  38. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_RFSwitchController_CryoRadiall.py +146 -0
  39. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_RPiCryo.py +198 -0
  40. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_RPiRadial.py +183 -0
  41. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/SW_RpiIQBox.py +41 -0
  42. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/THERM_TC0309.py +72 -0
  43. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/Tabor_P2584M.py +1874 -0
  44. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VNA_Agilent_N5232A.py +680 -0
  45. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VNA_Keysight_P9373A.py +17 -0
  46. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_Delft_IVVI.py +1194 -0
  47. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_IVVI_pyro.py +135 -0
  48. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_RpiMultiDAC.py +74 -0
  49. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_SIM928_PLX.py +371 -0
  50. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_SIM928_VCOM.py +381 -0
  51. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_SIM928_pyro.py +50 -0
  52. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/VOLT_Stahl_16CH.py +304 -0
  53. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/ZILabOneQ.py +41 -0
  54. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/__init__.py +0 -0
  55. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummyACQ.py +109 -0
  56. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummyACQex.py +120 -0
  57. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummyAWG.py +121 -0
  58. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummyDDG.py +116 -0
  59. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummyGENmwSource.py +125 -0
  60. sqdtoolz-0.9.0.dev1/sqdtoolz/Drivers/dummySMU.py +100 -0
  61. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiment.py +406 -0
  62. sqdtoolz-0.9.0.dev1/sqdtoolz/ExperimentConfiguration.py +464 -0
  63. sqdtoolz-0.9.0.dev1/sqdtoolz/ExperimentSpecification.py +150 -0
  64. sqdtoolz-0.9.0.dev1/sqdtoolz/ExperimentSpecifications/__init__.py +0 -0
  65. sqdtoolz-0.9.0.dev1/sqdtoolz/ExperimentSweeps.py +70 -0
  66. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpACstarkRamseyGE.py +122 -0
  67. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpBodePlot.py +69 -0
  68. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpCalibGE.py +67 -0
  69. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpCalibXrot.py +107 -0
  70. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpCalibXrotAuto.py +126 -0
  71. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpGateBenchmarks.py +109 -0
  72. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpHahnGE.py +121 -0
  73. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpMixerCalibrationLO.py +130 -0
  74. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpMixerCalibrationSB.py +102 -0
  75. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpPeakScouterIQ.py +68 -0
  76. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpPulsedCavitySpec.py +93 -0
  77. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpQubitFluxSweep.py +83 -0
  78. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpRabi.py +170 -0
  79. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpRamseyGE.py +125 -0
  80. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpRandomisedBenchmarking.py +142 -0
  81. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpResistanceIVs.py +54 -0
  82. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpResistanceIVsFast.py +45 -0
  83. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpSingleShotGE.py +74 -0
  84. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpT1GE.py +119 -0
  85. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpVNAEquations.py +120 -0
  86. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpVNAoptimalSNR.py +38 -0
  87. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIActiveResetTuneup.py +81 -0
  88. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIBenchmarkETH.py +95 -0
  89. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIBlobs.py +83 -0
  90. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZICalibX.py +142 -0
  91. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIChevrons.py +65 -0
  92. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIChevrons2QFixedCoupler.py +182 -0
  93. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZICryoscope.py +313 -0
  94. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIDailyTuneup.py +132 -0
  95. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIDispersive.py +110 -0
  96. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIDragScaling.py +90 -0
  97. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIFixedCouplerTuneup.py +152 -0
  98. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIQASM.py +133 -0
  99. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIQASMDataViewer.py +63 -0
  100. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIQubitFluxSweep.py +252 -0
  101. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIQubitPowerSweep.py +114 -0
  102. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIQubitSpec.py +59 -0
  103. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIRabi.py +111 -0
  104. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIRabiRamseyT1.py +164 -0
  105. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIRamsey.py +103 -0
  106. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIRandomisedBenchmarking.py +126 -0
  107. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIRes.py +123 -0
  108. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIResFluxSweep.py +101 -0
  109. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIResOptimal.py +224 -0
  110. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIResPowerSweep.py +66 -0
  111. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZISingleQubitTuneup.py +363 -0
  112. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIT1.py +86 -0
  113. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIT1SingleShot.py +53 -0
  114. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZITWPATuneup.py +134 -0
  115. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ExpZIqubit.py +289 -0
  116. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/calibrate_tunable_transmon_fixed_coupler.py +311 -0
  117. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/calibrate_tunable_transmon_fixed_coupler_osc.py +291 -0
  118. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/cryo_scope.py +329 -0
  119. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/flux_scope.py +309 -0
  120. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/oqasm_scheduled_qubits.py +320 -0
  121. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/qubit_single_chevron.py +290 -0
  122. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/qubit_spectroscopy_gef.py +288 -0
  123. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/single_qubit_gates.py +259 -0
  124. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/single_qubit_gates_sweep.py +280 -0
  125. sqdtoolz-0.9.0.dev1/sqdtoolz/Experiments/Experimental/ZI/sinlge_qubit_gates_sweep_chunking.py +288 -0
  126. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ACQ.py +171 -0
  127. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ACQdso.py +166 -0
  128. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ACQsa.py +108 -0
  129. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ACQvna.py +192 -0
  130. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/AWG.py +1057 -0
  131. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/DDG.py +93 -0
  132. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/DataProcessor.py +45 -0
  133. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/DecisionBlock.py +10 -0
  134. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Decisions/DEC_SVM.py +38 -0
  135. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENatten.py +34 -0
  136. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENfuncGen.py +86 -0
  137. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENmwSource.py +132 -0
  138. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENmwSrcAWG.py +157 -0
  139. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENsmu.py +176 -0
  140. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENswitch.py +38 -0
  141. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENswitchTrig.py +44 -0
  142. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENtherm.py +29 -0
  143. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/GENvoltSource.py +50 -0
  144. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/HALbase.py +78 -0
  145. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/LockableProperties.py +22 -0
  146. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/MultiACQ.py +160 -0
  147. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_AmpPhs.py +48 -0
  148. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_ChannelArithmetic.py +72 -0
  149. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_ConstantArithmetic.py +54 -0
  150. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_DDC.py +52 -0
  151. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Decimation.py +47 -0
  152. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Duplicate.py +35 -0
  153. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_ESD.py +54 -0
  154. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_FFT.py +55 -0
  155. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_FIR.py +67 -0
  156. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Integrate.py +39 -0
  157. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Max.py +39 -0
  158. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Mean.py +39 -0
  159. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_MeanBlock.py +46 -0
  160. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_MeanVariance.py +43 -0
  161. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Rename.py +27 -0
  162. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Slice.py +46 -0
  163. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_Variance.py +39 -0
  164. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/CPU/CPU_kMeans.py +49 -0
  165. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_DDC.py +54 -0
  166. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_DDCFIR.py +62 -0
  167. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_Decimation.py +29 -0
  168. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_FFT.py +24 -0
  169. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_FIR.py +56 -0
  170. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_Integrate.py +27 -0
  171. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_Mean.py +27 -0
  172. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/FPGA/FPGA_MultiplierConst.py +47 -0
  173. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_ChannelArithmetic.py +74 -0
  174. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_ConstantArithmetic.py +54 -0
  175. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_DDC.py +52 -0
  176. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Decimation.py +52 -0
  177. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Duplicate.py +35 -0
  178. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_ESD.py +56 -0
  179. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_FFT.py +57 -0
  180. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_FIR.py +87 -0
  181. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Integrate.py +37 -0
  182. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Max.py +37 -0
  183. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Mean.py +37 -0
  184. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_MeanBlock.py +47 -0
  185. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Rename.py +27 -0
  186. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/GPU/GPU_Slice.py +37 -0
  187. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/ProcessorCPU.py +176 -0
  188. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/ProcessorFPGA.py +91 -0
  189. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/Processors/ProcessorGPU.py +197 -0
  190. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/SOFTpid.py +169 -0
  191. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/SOFTqpu.py +254 -0
  192. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/TriggerPulse.py +223 -0
  193. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/WaveformGeneric.py +49 -0
  194. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/WaveformMapper.py +11 -0
  195. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/WaveformSegments.py +601 -0
  196. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/WaveformTransformations.py +221 -0
  197. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/QuantumElements/TunableTransmonCouplerFixed.py +139 -0
  198. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/QuantumElements/__init__.py +18 -0
  199. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/ZIACQ.py +209 -0
  200. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/ZIPulses.py +253 -0
  201. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/ZIQuantumElement.py +126 -0
  202. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/ZIQubit.py +294 -0
  203. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/ZIbase.py +3 -0
  204. sqdtoolz-0.9.0.dev1/sqdtoolz/HAL/ZI/__init__.py +3 -0
  205. sqdtoolz-0.9.0.dev1/sqdtoolz/Laboratory.py +654 -0
  206. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/DataFitting.py +776 -0
  207. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/DataIQDiscriminate.py +160 -0
  208. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/DataIQNormalise.py +76 -0
  209. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/DataQubitFlux.py +309 -0
  210. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/DataSingleShotThreshold.py +92 -0
  211. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/ExperimentViewer.py +878 -0
  212. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/FileConverter.py +49 -0
  213. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/FileIO.py +592 -0
  214. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/FileJSON.py +48 -0
  215. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/Flattenator.py +168 -0
  216. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/Miscellaneous.py +111 -0
  217. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/ParserOpenQASM.py +1195 -0
  218. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/ScheduleParametersJSONConfigZI.py +72 -0
  219. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/ScheduleParametersSoftQPUZI.py +44 -0
  220. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/__init__.py +27 -0
  221. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/includes/stdgates.inc +270 -0
  222. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/OpenQASM/includes/stdgates_transmon_fixed_coupler.inc +24 -0
  223. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/Optimisers.py +64 -0
  224. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/QubitGates.py +264 -0
  225. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/ResonatorTools.py +2469 -0
  226. sqdtoolz-0.9.0.dev1/sqdtoolz/Utilities/TimingPlots.py +328 -0
  227. sqdtoolz-0.9.0.dev1/sqdtoolz/Variable.py +387 -0
  228. sqdtoolz-0.9.0.dev1/sqdtoolz/__init__.py +42 -0
  229. sqdtoolz-0.9.0.dev1/sqdtoolz.egg-info/PKG-INFO +125 -0
  230. sqdtoolz-0.9.0.dev1/sqdtoolz.egg-info/SOURCES.txt +231 -0
  231. sqdtoolz-0.9.0.dev1/sqdtoolz.egg-info/dependency_links.txt +1 -0
  232. sqdtoolz-0.9.0.dev1/sqdtoolz.egg-info/requires.txt +16 -0
  233. sqdtoolz-0.9.0.dev1/sqdtoolz.egg-info/top_level.txt +1 -0
@@ -0,0 +1,203 @@
1
+ Copyright 2026 NQCT Australia
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or Derivative
97
+ Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute
110
+ must include a readable copy of the attribution notices
111
+ contained within such NOTICE file, excluding those notices
112
+ that do not pertain to any part of the Derivative Works,
113
+ in at least one of the following places: within a NOTICE text
114
+ file distributed as part of the Derivative Works; within the
115
+ Source form or documentation, if provided along with the
116
+ Derivative Works; or, within a display generated by the
117
+ Derivative Works, if and wherever such third-party notices
118
+ normally appear. The contents of the NOTICE file are for
119
+ informational purposes only and do not modify the License.
120
+ You may add Your own attribution notices within Derivative
121
+ Works that You distribute, alongside or as an addendum to
122
+ the NOTICE text from the Work, provided that such additional
123
+ attribution notices cannot be construed as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing
143
+ the origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "{}"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright {yyyy} {name of copyright owner}
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.4
2
+ Name: sqdtoolz
3
+ Version: 0.9.0.dev1
4
+ Summary: toolbox to control and run experiments
5
+ Author-email: Prasanna Pakkiam <p.pakkiam@uq.edu.au>, Rohit Beriwal <r.beriwal@uq.edu.au>
6
+ Project-URL: Homepage, https://github.com/sqdlab/sqdtoolz
7
+ Keywords: control toolbox,timing
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Programming Language :: Python :: 3 :: Only
10
+ Classifier: Operating System :: OS Independent
11
+ Requires-Python: >=3.10
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: numpy
15
+ Requires-Dist: matplotlib
16
+ Requires-Dist: scipy
17
+ Requires-Dist: bokeh
18
+ Requires-Dist: openqasm3
19
+ Requires-Dist: openpulse
20
+ Requires-Dist: pandas==2.3.3
21
+ Requires-Dist: h5py
22
+ Provides-Extra: full
23
+ Requires-Dist: qcodes>=0.21.0; extra == "full"
24
+ Requires-Dist: pyvisa-py; extra == "full"
25
+ Requires-Dist: resonator-tools; extra == "full"
26
+ Requires-Dist: ply; extra == "full"
27
+ Requires-Dist: laboneq; extra == "full"
28
+ Requires-Dist: laboneq-applications; extra == "full"
29
+ Dynamic: license-file
30
+
31
+ # SQDToolz
32
+
33
+ [![UnitTests](https://github.com/sqdlab/SQDToolz/actions/workflows/UnitTests.yaml/badge.svg)](https://github.com/sqdlab/SQDToolz/actions/workflows/UnitTests.yaml)
34
+
35
+ This is a toolbox to control instruments to run a general lab experiments. This was designed to supersede *UQTools*, keeping simplicity, scalability and efficiency in check. It currently uses QCoDeS to communicate with the instruments, while providing higher level functionality such as timing control, pulse generation, automatic parameter updates and data/configuration storage.
36
+
37
+ There are two classes of documentation provided for this stack:
38
+
39
+ - [User documentation](docs/User/Readme.md)
40
+ - [Driver-specific documentation](docs/User/InstrumentSpecific/Readme.md)
41
+ - [Custom device documentation](docs/User/CustomDevices/Readme.md)
42
+ - [Measurement methods](docs/User/MeasurementMethods/Readme.md)
43
+ - [Developer documentation](docs/Developer/Readme.md)
44
+
45
+
46
+ ## Installation instructions:
47
+
48
+ Although SQDToolz is on PyPI to satisfy other dependency chains, it is typically installed by cloning the repository and running the setup file via pip as an editable installation. Note that it is done in the editable mode so that one may modify the stack and push changes to GIT without upsetting the pip package manager. If the goal is to simply install the latest standalone release, then just run `pip install sqdtoolz[full]` after activating the venv (i.e. no need to clone the repository etc.). Omit `[full]` if the instrumentation/control stack need not be installed.
49
+
50
+ Run Anaconda prompt and run the following command to create an environment (in this example, the name is sqdtoolz_env):
51
+
52
+ ```
53
+ conda create -n sqdtoolz_env python=3.10
54
+ ```
55
+
56
+ Now activate the environment:
57
+
58
+ ```
59
+ activate sqdtoolz_env
60
+ ```
61
+
62
+ Now choose a folder to house the SQDToolz stack (idea is to create an editable folder such that the code can be modified and pushed without upsetting the pip package manager). Once navigating to this folder, run the usual GIT clone:
63
+
64
+ ```
65
+ cd C:/Users/....../myFolder/
66
+ git clone https://github.com/sqdlab/sqdtoolz.git
67
+ ```
68
+
69
+ Now there is a sqdtoolz folder in the current directory. Do not enter this new folder. Simply run:
70
+
71
+ ```
72
+ pip install -e sqdtoolz[full]
73
+ ```
74
+
75
+ This should install all required dependencies.
76
+
77
+ ## Updating new required packages
78
+
79
+ Just log into the virtual environment, navigate to the sqdtoolz folder and then run:
80
+
81
+ ```
82
+ python -m pip install -e sqdtoolz[full]
83
+ ```
84
+
85
+ ## Basic design overview:
86
+
87
+ The stack is structured as follows:
88
+
89
+ 1. Laboratory - highest level object that holds experiment parameters, runs experiments and handles saving of data and experiment+instrument configurations
90
+
91
+ 2. Experiment - an object when run will generate a set of input gates (e.g. to a qubit) while receiving output signals (e.g. qubit readout). The language here is generic and agnostic to the underlying implementation.
92
+
93
+ 3. Experiment-Configuration - sets up the trigger relations between the HAL instruments and handles the translations of generic pulse sequences into the actual AWG channels (e.g. mapping a qubit gate-sequence onto two AWG channels when using IQ modulation).
94
+
95
+ 4. HAL - the Hardware-Abstraction-Layer is used to package raw instruments (e.g. DDG, AWG and ACQ instruments) for use in describing trigger relationships and to send commands (e.g. programming waveforms) in an instrument-agnostic manner (i.e. the interface to command different AWGs is done so via the same object properties and interface functions). The HAL abstracts the specific device into a particular type; this standardisation enables easy browsing of parameters. For example, given two microwave sources from Tektronix and Keysight, both sources will use the associated HAL object `GENmwSource` to ensure a uniform API when handling said objects (e.g. to set the output frequency, one just sets the universal `Frequency` property of the `GENmwSource` object).
96
+
97
+ 5. QCoDeS-Drivers: This has all the vendor level drivers for the instruments. Most instruments have pyVISA implementation, while others use local APIs (e.g. HiSLIP or some DLL).
98
+
99
+ ## Overview
100
+
101
+ Basic workflow involves:
102
+
103
+ - A `Laboratory` object is created for a given experimental run. This specifies the output directory.
104
+ - Devices that may be used are specified in the YAML (as per QCoDeS).
105
+ - Devices desired for a given experimental run are loaded from the YAML and then housed inside HAL objects
106
+ - Devices desired for a particular experiment are loaded into an `ExperimentConfiguration` object to store all HAL parameters and device settings (e.g. waveforms, frequencies, powers etc.) and trigger relationships for the timing diagram.
107
+ - When running an experiment (whether it is a default one or a custom one), the given `ExperimentConfiguration` object is used to instantiate the `Experiment` object.
108
+
109
+ When the experiment finishes, it creates a folder with the date and time-stamp. Said folder includes:
110
+
111
+ - At least, one HDF5 file with the output data (usually updated in real-time to enable live-plotting)
112
+ - `timing_diagram.png` - the timing diagram of instruments used in the current experiment highlighting the trigger relationships and the time-frames win which instruments output or acquire signals.
113
+ - `laboratory_parameters.txt` - names and values of currently defined `Variable` objects in the current experimental run
114
+ - `laboratory_configuration.txt` - a full dump of all HAL-level instrument parameters. This is used to easily browse the instrument parameters (e.g. frequency, power, sample-rates etc.). In fact, the `ExperimentViewer` UI uses this file to easily compare instrument parameters between two different experiments.
115
+ - `instrument_configuration.txt` - a QCoDeS instrument parameter dump. Used as a last resort for it is heavily obfuscated with the device-specific parameters.
116
+
117
+ Note that the folder may also include other files such as fitted plots if the derived `Experiment` object outputs said files. Other noteworthy features include:
118
+
119
+ - Flexible waveform generation engine that includes auto-compression that utilises the sequencing functionality (in supported AWGs) to lower the waveform memory usage.
120
+ - Live `ExperimentViewer` module that shows the current state of all HAL-level parameters in the experiment. It is useful to help ensure that the desired instruments are in the correct states during the experiment. It can be run via `lab.open_browser()`.
121
+ - Live plotting engine when using SQDViz.
122
+ - Structural types supported via `ExperimentSpecification`. For example, a qubit type can hold parameters such as its drive frequency, optimal drive amplitude/time for Pauli-X Gates, T1 time etc.
123
+
124
+ It should be noted that experiments can automatically interface with parameters (either inside `ExperimentSpecification` or normal `Variable` objects). For example, a Rabi experiment will automatically fit the resulting oscillations to update the currently optimal drive amplitude and time for Pauli-X gates on a given qubit. Thus, one may run cascades of experiments in an automated sequence. A usual sequence might be to run a Rabi experiment (update the currently optimal tipping $\pi/2$ amplitude), run a more optimal Ramsey experiment (update the detuning frequency) and finally run a T1 experiment with the optimal qubit drive parameters. This three-experiment combination could be run in a loop with all **parameters being updated and saved automatically in real-time**. Using the experiment grouping functionality, one may group all said experiments into a single time-stamped folder with the data IO retrieval functionality present to automatically amalgamate all results across multiple experiments (e.g. this is useful when trying to collate all T1 values when generating T1-statistics).
125
+
@@ -0,0 +1,95 @@
1
+ # SQDToolz
2
+
3
+ [![UnitTests](https://github.com/sqdlab/SQDToolz/actions/workflows/UnitTests.yaml/badge.svg)](https://github.com/sqdlab/SQDToolz/actions/workflows/UnitTests.yaml)
4
+
5
+ This is a toolbox to control instruments to run a general lab experiments. This was designed to supersede *UQTools*, keeping simplicity, scalability and efficiency in check. It currently uses QCoDeS to communicate with the instruments, while providing higher level functionality such as timing control, pulse generation, automatic parameter updates and data/configuration storage.
6
+
7
+ There are two classes of documentation provided for this stack:
8
+
9
+ - [User documentation](docs/User/Readme.md)
10
+ - [Driver-specific documentation](docs/User/InstrumentSpecific/Readme.md)
11
+ - [Custom device documentation](docs/User/CustomDevices/Readme.md)
12
+ - [Measurement methods](docs/User/MeasurementMethods/Readme.md)
13
+ - [Developer documentation](docs/Developer/Readme.md)
14
+
15
+
16
+ ## Installation instructions:
17
+
18
+ Although SQDToolz is on PyPI to satisfy other dependency chains, it is typically installed by cloning the repository and running the setup file via pip as an editable installation. Note that it is done in the editable mode so that one may modify the stack and push changes to GIT without upsetting the pip package manager. If the goal is to simply install the latest standalone release, then just run `pip install sqdtoolz[full]` after activating the venv (i.e. no need to clone the repository etc.). Omit `[full]` if the instrumentation/control stack need not be installed.
19
+
20
+ Run Anaconda prompt and run the following command to create an environment (in this example, the name is sqdtoolz_env):
21
+
22
+ ```
23
+ conda create -n sqdtoolz_env python=3.10
24
+ ```
25
+
26
+ Now activate the environment:
27
+
28
+ ```
29
+ activate sqdtoolz_env
30
+ ```
31
+
32
+ Now choose a folder to house the SQDToolz stack (idea is to create an editable folder such that the code can be modified and pushed without upsetting the pip package manager). Once navigating to this folder, run the usual GIT clone:
33
+
34
+ ```
35
+ cd C:/Users/....../myFolder/
36
+ git clone https://github.com/sqdlab/sqdtoolz.git
37
+ ```
38
+
39
+ Now there is a sqdtoolz folder in the current directory. Do not enter this new folder. Simply run:
40
+
41
+ ```
42
+ pip install -e sqdtoolz[full]
43
+ ```
44
+
45
+ This should install all required dependencies.
46
+
47
+ ## Updating new required packages
48
+
49
+ Just log into the virtual environment, navigate to the sqdtoolz folder and then run:
50
+
51
+ ```
52
+ python -m pip install -e sqdtoolz[full]
53
+ ```
54
+
55
+ ## Basic design overview:
56
+
57
+ The stack is structured as follows:
58
+
59
+ 1. Laboratory - highest level object that holds experiment parameters, runs experiments and handles saving of data and experiment+instrument configurations
60
+
61
+ 2. Experiment - an object when run will generate a set of input gates (e.g. to a qubit) while receiving output signals (e.g. qubit readout). The language here is generic and agnostic to the underlying implementation.
62
+
63
+ 3. Experiment-Configuration - sets up the trigger relations between the HAL instruments and handles the translations of generic pulse sequences into the actual AWG channels (e.g. mapping a qubit gate-sequence onto two AWG channels when using IQ modulation).
64
+
65
+ 4. HAL - the Hardware-Abstraction-Layer is used to package raw instruments (e.g. DDG, AWG and ACQ instruments) for use in describing trigger relationships and to send commands (e.g. programming waveforms) in an instrument-agnostic manner (i.e. the interface to command different AWGs is done so via the same object properties and interface functions). The HAL abstracts the specific device into a particular type; this standardisation enables easy browsing of parameters. For example, given two microwave sources from Tektronix and Keysight, both sources will use the associated HAL object `GENmwSource` to ensure a uniform API when handling said objects (e.g. to set the output frequency, one just sets the universal `Frequency` property of the `GENmwSource` object).
66
+
67
+ 5. QCoDeS-Drivers: This has all the vendor level drivers for the instruments. Most instruments have pyVISA implementation, while others use local APIs (e.g. HiSLIP or some DLL).
68
+
69
+ ## Overview
70
+
71
+ Basic workflow involves:
72
+
73
+ - A `Laboratory` object is created for a given experimental run. This specifies the output directory.
74
+ - Devices that may be used are specified in the YAML (as per QCoDeS).
75
+ - Devices desired for a given experimental run are loaded from the YAML and then housed inside HAL objects
76
+ - Devices desired for a particular experiment are loaded into an `ExperimentConfiguration` object to store all HAL parameters and device settings (e.g. waveforms, frequencies, powers etc.) and trigger relationships for the timing diagram.
77
+ - When running an experiment (whether it is a default one or a custom one), the given `ExperimentConfiguration` object is used to instantiate the `Experiment` object.
78
+
79
+ When the experiment finishes, it creates a folder with the date and time-stamp. Said folder includes:
80
+
81
+ - At least, one HDF5 file with the output data (usually updated in real-time to enable live-plotting)
82
+ - `timing_diagram.png` - the timing diagram of instruments used in the current experiment highlighting the trigger relationships and the time-frames win which instruments output or acquire signals.
83
+ - `laboratory_parameters.txt` - names and values of currently defined `Variable` objects in the current experimental run
84
+ - `laboratory_configuration.txt` - a full dump of all HAL-level instrument parameters. This is used to easily browse the instrument parameters (e.g. frequency, power, sample-rates etc.). In fact, the `ExperimentViewer` UI uses this file to easily compare instrument parameters between two different experiments.
85
+ - `instrument_configuration.txt` - a QCoDeS instrument parameter dump. Used as a last resort for it is heavily obfuscated with the device-specific parameters.
86
+
87
+ Note that the folder may also include other files such as fitted plots if the derived `Experiment` object outputs said files. Other noteworthy features include:
88
+
89
+ - Flexible waveform generation engine that includes auto-compression that utilises the sequencing functionality (in supported AWGs) to lower the waveform memory usage.
90
+ - Live `ExperimentViewer` module that shows the current state of all HAL-level parameters in the experiment. It is useful to help ensure that the desired instruments are in the correct states during the experiment. It can be run via `lab.open_browser()`.
91
+ - Live plotting engine when using SQDViz.
92
+ - Structural types supported via `ExperimentSpecification`. For example, a qubit type can hold parameters such as its drive frequency, optimal drive amplitude/time for Pauli-X Gates, T1 time etc.
93
+
94
+ It should be noted that experiments can automatically interface with parameters (either inside `ExperimentSpecification` or normal `Variable` objects). For example, a Rabi experiment will automatically fit the resulting oscillations to update the currently optimal drive amplitude and time for Pauli-X gates on a given qubit. Thus, one may run cascades of experiments in an automated sequence. A usual sequence might be to run a Rabi experiment (update the currently optimal tipping $\pi/2$ amplitude), run a more optimal Ramsey experiment (update the detuning frequency) and finally run a T1 experiment with the optimal qubit drive parameters. This three-experiment combination could be run in a loop with all **parameters being updated and saved automatically in real-time**. Using the experiment grouping functionality, one may group all said experiments into a single time-stamped folder with the data IO retrieval functionality present to automatically amalgamate all results across multiple experiments (e.g. this is useful when trying to collate all T1 values when generating T1-statistics).
95
+
@@ -0,0 +1,64 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "sqdtoolz"
7
+ version = "0.9.0.dev1"
8
+ description = "toolbox to control and run experiments"
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ authors = [
12
+ { name = "Prasanna Pakkiam", email = "p.pakkiam@uq.edu.au" },
13
+ { name = "Rohit Beriwal", email = "r.beriwal@uq.edu.au" }
14
+ ]
15
+ keywords = ["control toolbox", "timing"]
16
+
17
+ classifiers = [
18
+ "Development Status :: 3 - Alpha",
19
+ "Programming Language :: Python :: 3 :: Only",
20
+ "Operating System :: OS Independent",
21
+ ]
22
+
23
+ dependencies = [
24
+ "numpy",
25
+ "matplotlib",
26
+ "scipy",
27
+ "bokeh",
28
+ "openqasm3",
29
+ "openpulse",
30
+ "pandas==2.3.3",
31
+ "h5py"
32
+ ]
33
+
34
+ [project.optional-dependencies]
35
+ full = [
36
+ "qcodes>=0.21.0",
37
+ "pyvisa-py",
38
+ "resonator-tools",
39
+ "ply",
40
+ "laboneq",
41
+ "laboneq-applications",
42
+ ]
43
+
44
+ [dependency-groups]
45
+ dev = [
46
+ "build>=1.5.0",
47
+ "twine>=6.2.0",
48
+ ]
49
+
50
+ [project.urls]
51
+ Homepage = "https://github.com/sqdlab/sqdtoolz"
52
+
53
+ [tool.setuptools]
54
+ include-package-data = true
55
+ license-files = ["LICENSE"]
56
+
57
+ [tool.setuptools.packages.find]
58
+ include = ["sqdtoolz*"]
59
+
60
+ [tool.setuptools.package-data]
61
+ sqdtoolz = [
62
+ "**/*.py",
63
+ "**/*.inc",
64
+ ]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+