Merge pull request #658 from DiCarloLab-Delft/develop

release v0.3

.github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 Thanks for your interest in the project! We welcome pull requests from developers of all skill levels.
 
 If you find a bug or want to propose a new feature open an issue. If you have written some code that should be merged open a pull request describing your changes and why it should be merged.
-If you have a question or want to discuss something, feel free to send an email to Adriaan Rol (m.a.rol@tudelft.nl).
+If you have a question or want to discuss something, feel free to send an email to Miguel Serrao Moreira (miguel.moreira@tudelft.nl).
 
 ## Git branching model
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,7 +10,7 @@ Changes proposed in this pull request:
 @mention the name of someone you want to review this pull request. 
 
 In order for the pull request to be merged, the following conditions must be met:
-- travis test suite passes
+- test suite (Github actions) passes
 - all reasonable issues raised by codacy must be resolved 
 - a positive review is required
 

.github/workflows/python_test.yml

@@ -9,7 +9,9 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7]
+        #python-version: [3.6, 3.7]
+        # disabled 3.7 because of 'AttributeError: 'str' object has no attribute 'decode''
+        python-version: [3.6]
 
     steps:
     - uses: actions/checkout@v1

.gitignore

@@ -131,6 +131,9 @@ $RECYCLE.BIN/
 *.png
 pycqed/measurement/openql_experiments/output/*
 *.qmap
+# a file containing hashes is used to check if RB recompilation is needed
+*.qisa.hashes
+
 
 # data files
 # test data files should be explicitly added by hand (overriding .gitignore)

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+exclude: 'doc/conf.py'
+
+repos:
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.12.0
+    hooks:
+    -   id: pyupgrade
+        # for now don't force to change from %-operator to {}
+        args: [--keep-percent-format, --py36-plus]
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+    -   id: check-ast
+    -   id: check-builtin-literals
+    -   id: check-merge-conflict
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+    -   id: mixed-line-ending
+    -   id: trailing-whitespace
+
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: 'v1.5.6'  # Use the sha / tag you want to point at
+    hooks:
+    -   id: autopep8
+        args: [--max-line-length=120]
+

Changelog

@@ -0,0 +1,30 @@
+PycQED Changelog
+
+Legend:
++ Added feature
+* Improved/changed feature, compatible
+# Change that breaks existing interface
+- Bug fixed
+! Known issue / missing feature
+. Generic bullet
+
+
+v0.3 - 20211119
+# redesigned DIO timing calibration interface (PR #621):
+    . DIO modes now defined in instrument_drivers/library/DIO.py instead of individual instrument drivers
+    . usage: see examples/CC_examples/CC_demo_mux.py "DIO.calibrate"
+# support for Central Controller software v0.2.2 (older versions not supported)
+    . requires OpenQL > 0.8.1.dev4
+# removed support for deprecated hardware (PRs #620 and #646)
++ added support for real-time modulation of waveforms for microwave control
++ added support for mixer skewness calibration with real-time modulation
++ added support for virtual-Z gates
++ added multiple methods for parity check calibration and assessment
++ added multiple methods for parallel qubit calibration
+. many more undocumented changes
+
+v0.2 - 20191213
+. second public release
+
+v0.1 - 20161012
+. initial public release

README.md

@@ -1,14 +1,14 @@
-# PycQED 
+# PycQED
 [![Build Status](https://github.com/DiCarloLab-Delft/pycqed_py3/workflows/Build%20Status/badge.svg)](https://github.com/DiCarloLab-Delft/pycqed_py3/actions)
-[![DOI](https://zenodo.org/badge/49057179.svg)](https://zenodo.org/badge/latestdoi/49057179)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3574563.svg)](https://zenodo.org/record/3574563)
 [![Codacy](https://api.codacy.com/project/badge/Grade/1266308dd9b84d7b933c2b46804aeb12)](https://www.codacy.com/app/AdriaanOrganization/PycQED_py3?utm_source=github.com&utm_medium=referral&utm_content=DiCarloLab-Delft/PycQED_py3&utm_campaign=badger)
 [![codecov](https://codecov.io/gh/DiCarloLab-Delft/PycQED_py3/branch/master/graph/badge.svg)](https://codecov.io/gh/DiCarloLab-Delft/PycQED_py3)
 
-A Python-based measurement environment for circuit-QED experiments by the 
-[DiCarlo group](http://dicarlolab.tudelft.nl/) at [QuTech](http://qutech.nl/),
+A Python-based measurement environment for circuit-QED experiments by the
+[DiCarlo group](https://qutech.nl/lab/dicarlo-lab-welcome/) at [QuTech](http://qutech.nl/),
 Delft University of Technology.
-This module is build on top of [QCoDeS](http://qcodes.github.io/Qcodes/) and 
-is not intended as a stand-alone 
+This module is build on top of [QCoDeS](http://qcodes.github.io/Qcodes/) and
+is not intended as a stand-alone
 package.
 
 ## License
@@ -54,8 +54,8 @@ If you use this software in any of your publications we would appreciate it if y
 
 ## Overview of the main modules
 Below follows an overview of the main structure of the code. It makes sense to take a look around here if your are new to get a feeling where to find things.
-Also take a look at [this presentation](docs/160714_qcodes_meetup.pdf), where the relation to qcodes and the core concepts in the package are explained.
-Mind however that the code is continuously under development so if you think something should be in a different location feel free to tap me (Adriaan) on the shoulder or create an issue to discuss it.
+Also take a look at [this recent (March 2020) presentation](docs/200330_Introduction_to_PycQED_v2.pdf) and [this previous presentation](docs/160714_qcodes_meetup.pdf), where the relation to QCoDeS and the core concepts in the package are explained.
+Mind however that the code is continuously under development so if you think something should be in a different location feel free to tap me (Miguel) on the shoulder or create an issue to discuss it.
 
 ### Folder Structure
 + [docs](docs/)
@@ -142,5 +142,5 @@ It is split into personal folders for messing around with your personal files an
 A little document containing some handy git commands:
 [Git tips & tricks](docs/git_tips_and_tricks.md).
 
-Lecture series on scientific Python: 
+Lecture series on scientific Python:
 [Scientific Computing with Python](https://github.com/jrjohansson/scientific-python-lectures)

depr.py

@@ -0,0 +1,26 @@
+import sys
+import os
+from pathlib import Path
+
+# parameter handling
+path = 0
+if len(sys.argv)>1:
+    path = sys.argv[1]
+else:
+    raise RuntimeError("missing argument")
+
+src = Path(path)
+if not src.exists():
+    raise RuntimeError("path does not exist")
+
+if src.parts[0] != "pycqed":
+    raise RuntimeError("path should start with 'pycqed'")
+
+
+dst = Path('deprecated') / src.parent
+print(f"mkdir {str(dst)}")
+dst.mkdir(parents=True, exist_ok=True)
+
+cmd = f"git mv {str(src)} {str(dst)}"
+print(cmd)
+os.system(cmd)