From 0b3570f3cb039167f1c01fbc531a849ebeab7e46 Mon Sep 17 00:00:00 2001 From: Mikhail Astafev Date: Mon, 20 Sep 2021 17:21:37 +0200 Subject: [PATCH 1/6] Add placeholder changelog for qcodes 0.29.0 --- docs/changes/0.29.0.rst | 39 +++++++++++++++++++++++++++++++++++++++ docs/changes/index.rst | 1 + 2 files changed, 40 insertions(+) create mode 100644 docs/changes/0.29.0.rst diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst new file mode 100644 index 00000000000..cd0c68d34ce --- /dev/null +++ b/docs/changes/0.29.0.rst @@ -0,0 +1,39 @@ +Changelog for QCoDeS 0.29.0 +=========================== + +The September 2021 release of QCoDeS. + + +----------------- +Breaking Changes: +----------------- + +- . + + +---- +New: +---- + +- + + +--------- +Improved: +--------- + +- . + + +----------------- +Improved drivers: +----------------- + +- . + + +--------------- +Under the hood: +--------------- + +- . diff --git a/docs/changes/index.rst b/docs/changes/index.rst index 387435c58a4..d6b256308a0 100644 --- a/docs/changes/index.rst +++ b/docs/changes/index.rst @@ -2,6 +2,7 @@ Changelogs ========== .. toctree:: + 0.29.0 <0.29.0> 0.28.0 <0.28.0> 0.27.0 <0.27.0> 0.26.0 <0.26.0> From 54854a351ffb7ab14de4922a1f57de97a77994b8 Mon Sep 17 00:00:00 2001 From: Trevor Morgan Date: Tue, 21 Sep 2021 20:58:04 -0700 Subject: [PATCH 2/6] changelog updates --- docs/changes/0.29.0.rst | 45 +++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst index cd0c68d34ce..7f8aa6db132 100644 --- a/docs/changes/0.29.0.rst +++ b/docs/changes/0.29.0.rst @@ -4,36 +4,59 @@ Changelog for QCoDeS 0.29.0 The September 2021 release of QCoDeS. ------------------ -Breaking Changes: ------------------ - -- . - - ---- New: ---- -- +- Simultaneous ramping feature that enables you to sweep an AMI 3D magnet to (x,y,z) in + time T or at vector ramp rate R, ramping all 3 axes together (in parallel) and + making a linear/vector trajectory from current field to the setpoint + in 3D magnetic field space. Please see updates to the AMI magnet driver example + documentation. (#3233) +- Galil DMC-41x3 stepper motor controller that can be used with Janis probes for + moving the measurement arm. (#2626) --------- Improved: --------- -- . +- Documentation updates, contrib (#3375, #3370) +- Fix shapes of dond datasets with additional set-points. (#3305) +- Allow load experiment functions to accept duplicate experiment name + and new experiment raises warning if duplicate experiment is created. (#3296) +- Improvements to logging where we log the versions of installed packages in + the environment where QCoDeS runs. (#3289) +- Enables dond to take inner actions that are passed in the Sweep instances. + Actions for a sweep parameter will be called when the set value of that + parameter is changed. (#3283) +- Raise ``ValueError`` if given more than one result for the same parameter name. (#3265) +- Sphinx extension that documents parameter attributes on instrument classes. + There are documented using a proxy object that contains a __repr__ that contains + the code to construct the parameter class. (#3224) ----------------- Improved drivers: ----------------- -- . +- Keithley 2600 SMU support to return both voltage and current compliance limit errors. (#3251, #3339, #3362) +- Make ``SR86xBufferReadout`` parameter take kwargs and pass them to base class. (#3341) --------------- Under the hood: --------------- -- . +- Add type packages discovered by mypy --install-types. (#3379) +- ISSUE_TEMPLATE.md updates for reporting a bug. (#3345) +- Resolved uncertainties package issues. (#3334) +- Make it possible to manually trigger codeql. (#3329) +- Logging update to explicitly set encoding for file handler. (#3327) +- Create codeql-analysis.yml recommended by github. (#3314) +- Remove redundant filters from test runner. (#3295) +- Explicitly depend on setuptools. (#3294) +- Remove precommit job that is now handled by dedicated precommit ci. (#3293) +- Make qcodes install mostly pep517/518 compliant. (#3288) +- Work around legacy test issue with hf51.12.1 on conda forge. (#3278) + From 24a6e2fd82467ef2c6dc805c3a601a6170fbaaed Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 22 Sep 2021 03:58:45 +0000 Subject: [PATCH 3/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/changes/0.29.0.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst index 7f8aa6db132..030f60b937b 100644 --- a/docs/changes/0.29.0.rst +++ b/docs/changes/0.29.0.rst @@ -8,12 +8,12 @@ The September 2021 release of QCoDeS. New: ---- -- Simultaneous ramping feature that enables you to sweep an AMI 3D magnet to (x,y,z) in - time T or at vector ramp rate R, ramping all 3 axes together (in parallel) and - making a linear/vector trajectory from current field to the setpoint +- Simultaneous ramping feature that enables you to sweep an AMI 3D magnet to (x,y,z) in + time T or at vector ramp rate R, ramping all 3 axes together (in parallel) and + making a linear/vector trajectory from current field to the setpoint in 3D magnetic field space. Please see updates to the AMI magnet driver example documentation. (#3233) -- Galil DMC-41x3 stepper motor controller that can be used with Janis probes for +- Galil DMC-41x3 stepper motor controller that can be used with Janis probes for moving the measurement arm. (#2626) @@ -23,16 +23,16 @@ Improved: - Documentation updates, contrib (#3375, #3370) - Fix shapes of dond datasets with additional set-points. (#3305) -- Allow load experiment functions to accept duplicate experiment name +- Allow load experiment functions to accept duplicate experiment name and new experiment raises warning if duplicate experiment is created. (#3296) -- Improvements to logging where we log the versions of installed packages in +- Improvements to logging where we log the versions of installed packages in the environment where QCoDeS runs. (#3289) -- Enables dond to take inner actions that are passed in the Sweep instances. +- Enables dond to take inner actions that are passed in the Sweep instances. Actions for a sweep parameter will be called when the set value of that parameter is changed. (#3283) - Raise ``ValueError`` if given more than one result for the same parameter name. (#3265) -- Sphinx extension that documents parameter attributes on instrument classes. - There are documented using a proxy object that contains a __repr__ that contains +- Sphinx extension that documents parameter attributes on instrument classes. + There are documented using a proxy object that contains a __repr__ that contains the code to construct the parameter class. (#3224) @@ -59,4 +59,3 @@ Under the hood: - Remove precommit job that is now handled by dedicated precommit ci. (#3293) - Make qcodes install mostly pep517/518 compliant. (#3288) - Work around legacy test issue with hf51.12.1 on conda forge. (#3278) - From a21551ea04ccc78eb32818d0b8ea52fa868a42b2 Mon Sep 17 00:00:00 2001 From: Mikhail Astafev Date: Wed, 22 Sep 2021 09:30:43 +0200 Subject: [PATCH 4/6] Remove items that are part of 0.28, some edits --- docs/changes/0.29.0.rst | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst index 030f60b937b..d5f4b2db5e4 100644 --- a/docs/changes/0.29.0.rst +++ b/docs/changes/0.29.0.rst @@ -21,26 +21,16 @@ New: Improved: --------- -- Documentation updates, contrib (#3375, #3370) -- Fix shapes of dond datasets with additional set-points. (#3305) -- Allow load experiment functions to accept duplicate experiment name - and new experiment raises warning if duplicate experiment is created. (#3296) -- Improvements to logging where we log the versions of installed packages in - the environment where QCoDeS runs. (#3289) -- Enables dond to take inner actions that are passed in the Sweep instances. - Actions for a sweep parameter will be called when the set value of that - parameter is changed. (#3283) -- Raise ``ValueError`` if given more than one result for the same parameter name. (#3265) -- Sphinx extension that documents parameter attributes on instrument classes. - There are documented using a proxy object that contains a __repr__ that contains - the code to construct the parameter class. (#3224) +- Documentation: clarified contribution guides and contacts (#3375, #3370) +- Raise ``ValueError`` if given more than one result for the same parameter name + in ``DataSaver.add_result``. (#3265) ----------------- Improved drivers: ----------------- -- Keithley 2600 SMU support to return both voltage and current compliance limit errors. (#3251, #3339, #3362) +- Keithley 2600 SMU support to return both voltage and current compliance limit errors. (#3339, #3362) - Make ``SR86xBufferReadout`` parameter take kwargs and pass them to base class. (#3341) @@ -48,14 +38,15 @@ Improved drivers: Under the hood: --------------- +- Make qcodes install mostly pep517/518 compliant. (#3288) +- Logging update to explicitly set encoding for file handler thus + preventing issues on systems with less widespread encodings. (#3327) - Add type packages discovered by mypy --install-types. (#3379) -- ISSUE_TEMPLATE.md updates for reporting a bug. (#3345) - Resolved uncertainties package issues. (#3334) -- Make it possible to manually trigger codeql. (#3329) -- Logging update to explicitly set encoding for file handler. (#3327) -- Create codeql-analysis.yml recommended by github. (#3314) -- Remove redundant filters from test runner. (#3295) - Explicitly depend on setuptools. (#3294) +- Work around legacy test issue with ``hf5`` ``1.12.1`` on conda forge. (#3278) +- ISSUE_TEMPLATE.md updates for reporting a bug. (#3345) +- Make it possible to manually trigger codeql, using codeql-analysis.yml + recommended by github. (#3314, #3329) +- Remove redundant filters from test runner. (#3295) - Remove precommit job that is now handled by dedicated precommit ci. (#3293) -- Make qcodes install mostly pep517/518 compliant. (#3288) -- Work around legacy test issue with hf51.12.1 on conda forge. (#3278) From e6d31c9d7d00acb01b9dd054a40c82a3d015b26c Mon Sep 17 00:00:00 2001 From: Mikhail Astafev Date: Wed, 22 Sep 2021 09:31:32 +0200 Subject: [PATCH 5/6] remove more items that are part of 0.28 --- docs/changes/0.29.0.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst index d5f4b2db5e4..442775e0799 100644 --- a/docs/changes/0.29.0.rst +++ b/docs/changes/0.29.0.rst @@ -43,10 +43,8 @@ Under the hood: preventing issues on systems with less widespread encodings. (#3327) - Add type packages discovered by mypy --install-types. (#3379) - Resolved uncertainties package issues. (#3334) -- Explicitly depend on setuptools. (#3294) - Work around legacy test issue with ``hf5`` ``1.12.1`` on conda forge. (#3278) - ISSUE_TEMPLATE.md updates for reporting a bug. (#3345) - Make it possible to manually trigger codeql, using codeql-analysis.yml recommended by github. (#3314, #3329) - Remove redundant filters from test runner. (#3295) -- Remove precommit job that is now handled by dedicated precommit ci. (#3293) From b339be1aee2c719a0c38c082ccbbec8d047c8659 Mon Sep 17 00:00:00 2001 From: Mikhail Astafev Date: Wed, 22 Sep 2021 09:33:44 +0200 Subject: [PATCH 6/6] and remove more items that were in 0.28 --- docs/changes/0.29.0.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/changes/0.29.0.rst b/docs/changes/0.29.0.rst index 442775e0799..b29af6848e5 100644 --- a/docs/changes/0.29.0.rst +++ b/docs/changes/0.29.0.rst @@ -38,12 +38,10 @@ Improved drivers: Under the hood: --------------- -- Make qcodes install mostly pep517/518 compliant. (#3288) - Logging update to explicitly set encoding for file handler thus preventing issues on systems with less widespread encodings. (#3327) - Add type packages discovered by mypy --install-types. (#3379) - Resolved uncertainties package issues. (#3334) -- Work around legacy test issue with ``hf5`` ``1.12.1`` on conda forge. (#3278) - ISSUE_TEMPLATE.md updates for reporting a bug. (#3345) - Make it possible to manually trigger codeql, using codeql-analysis.yml recommended by github. (#3314, #3329)