Merge pull request #589 from qutech/issues/582_towncrier

Track changes with towncrier
qutech · May 17, 2021 · 2877eee · 2877eee
2 parents 25e0f71 + 657f781
commit 2877eee
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,9 @@ The current feature list is as follows:
 - High-level pulse to hardware configuration and waveform translation routines 
 - Hardware drivers for Tabor Electronics, Tektronix and Zurich Instruments AWGs and AlazarTech Digitizers
 - MATLAB interface to access qupulse functionality
+
+Pending changes are tracked in the `changes.d` subdirectory and published in [`RELEASE_NOTES.rst`](RELEASE_NOTES.rst) on
+release using the tool `towncrier`.
 
 ## Installation
 qupulse is available on [PyPi](https://pypi.org/project/qupulse/) and the latest release can be installed by executing:

diff --git a/ReleaseNotes.txt → RELEASE_NOTES.rst b/ReleaseNotes.txt → RELEASE_NOTES.rst
@@ -1,30 +1,20 @@
-## pending/current ##
- - General:
-    - Fix TimeType comparisons with non-finite floats (inf, -inf, NaN)
-    - Drop python 3.5 support
-    - Added ConstantPulseTemplate (#565)
-
- - Expressions:
-    - Add `evaluate_with_exact_rationals` method to ExpressionScalar
+.. towncrier release notes start
 
- - Hardware:
-    - Improve atsaverage backend usability
+0.5.1
+=====
 
+- General:
+   - Unify `TimeType.from_float` between fractions and gmpy2 backend behaviour (fixes issue 529).
 
-## 0.5.1 ##
-
- - General:
-    - Unify `TimeType.from_float` between fractions and gmpy2 backend behaviour (fixes issue 529).
-
-## 0.5 ##
+0.5
+=====
 
- - General:
+- General:
    - Improve `TimeType` consistency by leveraging str(float) for rounding by default.
    - Add support for sympy==1.5
-   - Add volatile parameters. Repetition counts can now be changed at runtime in some cases (useful for DNP). See
-     `volatile` kwarg of `create_program`
+   - Add volatile parameters. Repetition counts can now be changed at runtime in some cases (useful for DNP). See `volatile` kwarg of `create_program`
 
- - Hardware:
+- Hardware:
    - Add a `measure_program` method to the DAC interface. This method is used by the QCoDeS integration.
    - Add a `set_measurement_mask` to DAC interface. This method is used by the QCoDeS integration.
    - Add a `get_sample_times` util method to share code for exact and fast sample time calculation
@@ -56,7 +46,8 @@
       - InstructionBlock: Old representation of programs. Replaced by Loop
       - MultiChannelProgram: Was required in the instruction block framework
 
-## 0.4 ##
+0.4
+=====
 
 - General:
     - Add utility function `qupulse.utils.types.has_type_interface` and use it to circumvent autoreload triggered isinstance fails
@@ -68,7 +59,8 @@
     - Plotting:
         - Make `plotting.render` behaviour and return value consistent between calls with `InstructionBlock` and `Loop`. Render now always returns 3 arguments.
 
-## 0.3 ##
+0.3
+=====
 
 - General:
     - Introduce qupulse.utils.isclose (an alias for math.isclose if available)
@@ -93,19 +85,16 @@
 - Parameters:
     - `ConstantParameter` now accepts a `Expression` without free variables as value (given as `Expression` or string)
 
-## 0.2 ##
+0.2
+=====
 
 - General:
-
-    - officially removed support for Python 3.3 (qupulse and dependencies are not compatible anymore)
+   - officially removed support for Python 3.3 (qupulse and dependencies are not compatible anymore)
 
 - Serialization / Storage:
-
-    - Added functionality to easily access available content/identifiers in `PulseStorage` and `StorageBackend`.
-    - DEPRECATED `list_contents()` of `StorageBackend` (use `contents property` instead).
-    - DEPRECATED: `CachingBackend` because its functionality is a subset of `PulseStorage`.
+   - Added functionality to easily access available content/identifiers in `PulseStorage` and `StorageBackend`.
+   - DEPRECATED `list_contents()` of `StorageBackend` (use `contents property` instead).
+   - DEPRECATED: `CachingBackend` because its functionality is a subset of `PulseStorage`.
 
 - Expressions:
-    - Fixed bug in `Expression.evaluate_numeric` if result is array of numeric sympy objects
-
-## 0.1.2 ##
+   - Fixed bug in `Expression.evaluate_numeric` if result is array of numeric sympy objects
diff --git a/changes.d/.gitignore b/changes.d/.gitignore
@@ -0,0 +1 @@
+!.gitignore
diff --git a/changes.d/504.removal b/changes.d/504.removal
@@ -0,0 +1 @@
+Drop support for python 3.5
diff --git a/changes.d/536.bugfix b/changes.d/536.bugfix
@@ -0,0 +1 @@
+Fix TimeType comparisons with non-finite floats (inf, -inf, NaN)
diff --git a/changes.d/546.feature b/changes.d/546.feature
@@ -0,0 +1 @@
+Add `evaluate_with_exact_rationals` method to `ExpressionScalar`
diff --git a/changes.d/557.feature b/changes.d/557.feature
@@ -0,0 +1 @@
+New feature based AWG abstraction. Can be found in `qupulse.hardware.feature_awg`. Allows easier code reuse across awg drivers.
diff --git a/changes.d/565.feature b/changes.d/565.feature
@@ -0,0 +1 @@
+Add ConstantPulseTemplate
diff --git a/changes.d/566.feature b/changes.d/566.feature
@@ -0,0 +1 @@
+Add interface to use `atsaverage` auto rearm
diff --git a/changes.d/571.bugfix b/changes.d/571.bugfix
@@ -0,0 +1,4 @@
+Improve alazar usability:
+  - Do not touch the default config when arming a measurement
+  - Keep current config in a seperate field
+  - Extend record to a multiple of a configurable value (4KB by default)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,2 +1,10 @@
 [build-system]
 requires = ["setuptools", "wheel"]
+
+[tool.towncrier]
+directory = "changes.d"
+package = "qupulse"
+package_dir = "./qupulse"
+filename = "RELEASE_NOTES.rst"
+name = "qupulse"
+issue_format = "`#{issue} <https://github.com/qutech/qupulse/issues/{issue}>`_"