Merge pull request #15 from HRL-Laboratories/crosstalk-compensation-and-docs

demo notebooks, docs, and crosstalk compensation

Author: abbiewessels

.gitignore

@@ -10,8 +10,7 @@ build
 htmlcov/
 
 # Sphinx documentation
-doc/*build*/
-doc/_autosummary
+docs/_build/
 
 # IDE Files
 .idea

.pre-commit-config.yaml

@@ -54,7 +54,7 @@ repos:
         entry: end-of-file-fixer
         language: system
         types: [text]
-        stages: [commit, push, manual]
+        stages: [pre-commit, pre-push, manual]
       - id: mixed-line-ending
         name: Mixed line ending
         description: Replaces or checks mixed line ending
@@ -67,4 +67,4 @@ repos:
         entry: trailing-whitespace-fixer
         language: system
         types: [text]
-        stages: [commit, push, manual]
+        stages: [pre-commit, pre-push, manual]

CHANGELOG.md

@@ -1,3 +1,12 @@
+v2.0.1
+======
+- docs added
+- demo notebooks added and working
+- default config location moved to location in package to streamline setup
+- all exchange only experiments are set up to use the crosstalk compensation firmware
+- added pyproject.toml for configuration of dev tools
+- added general environment.yml for environment creation without all the packages for developers
+
 v2.0.0
 ======
 - utilizes tprocv2 firmware and API from qick
@@ -20,11 +29,11 @@ v0.0.2
 
 v0.0.1
 ======
-- Added a more comprehensive gateset for ALLXY phase control demo 
-- Split the idle cell scan functionality and added a new class to handle IdleCell experiment setup in the psb_setup_program.py 
-- Added a routine for electron temperature sweeps (and more generally 1D cuts in the PvP) in the electrostatic tuning set of functionality (based on TODO listed in initial version) 
-- Split and added some low-level functionality to conduct voltage compensation 
-- Added fields for LD qubit RF drive parameters and a new HemtBias model for parameter tracking 
+- Added a more comprehensive gateset for ALLXY phase control demo
+- Split the idle cell scan functionality and added a new class to handle IdleCell experiment setup in the psb_setup_program.py
+- Added a routine for electron temperature sweeps (and more generally 1D cuts in the PvP) in the electrostatic tuning set of functionality (based on TODO listed in initial version)
+- Split and added some low-level functionality to conduct voltage compensation
+- Added fields for LD qubit RF drive parameters and a new HemtBias model for parameter tracking
 - general bug fixes for file saving, configs etc
 - debugging of the PSB spin averager
 

README.md

@@ -7,7 +7,7 @@
 ## Description
 Welcome to spinQICK, an open-source extension to the [Quantum Instrumentation Control Kit](https://github.com/openquantumhardware/qick) (QICK) designed to control electrostatically confined solid-state spin-qubits! SpinQICK enables researchers to use low-cost off-the-shelf Xilinx Radio Frequency System-on-Chip (RFSoC) Field Programmable Gate Arrays (FPGAs) to rapidly develop novel application specific experimental hardware and software for controlling spin-qubits.
 
-This package utilizes both the standard QICK API and modified low-level QICK assembly to implement standard measurement and control methods that are unique to electrostatically confined spin-qubit systems. These methods currently accomodate single-spin (Loss-DiVincenzo) qubits and include charge-stability and electrostatic tune-up, initialization and parity readout, single-spin and exchange-only coherent control and characterization (T1, T2*, T2-Echo, Ramsey, All-XY), exchange calibration, and two-qubit gates between single-spins. In addition to these facilities, this package also provides features for parameter-management, plotting, basic data management and demonstrations to help get started with spinQICK. 
+This package utilizes both the standard QICK API and modified low-level QICK assembly to implement standard measurement and control methods that are unique to electrostatically confined spin-qubit systems. These methods currently accomodate single-spin (Loss-DiVincenzo) qubits and include charge-stability and electrostatic tune-up, initialization and parity readout, single-spin and exchange-only coherent control and characterization (T1, T2*, T2-Echo, Ramsey, All-XY), exchange calibration, and two-qubit gates between single-spins. In addition to these facilities, this package also provides features for parameter-management, plotting, basic data management and demonstrations to help get started with spinQICK.
 
 The repository contains code for spinQICK V2, which updates spinQICK for compatibility with the updated [tProcV2](https://github.com/meeg/qick_demos_sho/blob/main/tprocv2/qick_processor_TRM.pdf) core processor from QICK. This expands the number of DACs from 8 to 16, allowing for six single-qubits or two exchange-only qubits. In addition to this, the latest firmware allows for upto five digitization channels. spinQICK V2 makes use of a modified firmware, found [here](https://s3df.slac.stanford.edu/people/meeg/qick/tprocv2/2025-06-11_216_tprocv2r23_rfbv2_16fullspeed/), that enables 16 full-speed outputs with real-only generation for improved waveform memory. Near-term updates will include cross-talk compensation with this firmware as well.
 

VERSION.txt

@@ -1 +1 @@
-2.0.0
+2.0.1