Release v0.5.0 (#1664)

Dominik-Vogel · web-flow · commit 53fd1d271e86 · 2019-08-13T11:25:52.000+02:00
Add changelog for v0.5.0
diff --git a/docs/changes/0.3.0.rst b/docs/changes/0.3.0.rst
@@ -4,41 +4,52 @@ Changelog for QCoDeS 0.3.0
 The May 2019 release of QCoDeS contains a large backend re-structure of the Measurement.DataSaver logic
 as well a handful of driver improvements and some new data saving functionalities.
 
-## New & Improved
+New & Improved:
+_______________
 
 - New and Improved Drivers:
 
   - Alazar Cards:
-    - All models; limit maximum buffer size as documented for AlazarBeforeAsyncRead (#1535)
-    - All models; add api instance as initialization parameter (#1524)
+
+    * All models; limit maximum buffer size as documented for AlazarBeforeAsyncRead (#1535)
+    * All models; add api instance as initialization parameter (#1524)
 
   - Arbitraty Waveform Generators:
-    - Keysight 33510B: add support for this specific model (#1544)
-    - Zurich Instruments HDAWG8; Remove warning when taking snapshot of ZIHDAWG8 (#1561)
+
+    * Keysight 33510B: add support for this specific model (#1544)
+    * Zurich Instruments HDAWG8; Remove warning when taking snapshot of ZIHDAWG8 (#1561)
 
   - Lock-in Amplifiers:
-    - Zurich Instruments UHF-LI; support all 8 oscillators with MF option (#1546)
-    - Zurich Instruments UHF-LI; add parameter to UHFLI driver to select oscillator per demodulator (#1551)
+
+    * Zurich Instruments UHF-LI; support all 8 oscillators with MF option (#1546)
+    * Zurich Instruments UHF-LI; add parameter to UHFLI driver to select oscillator per demodulator (#1551)
 
   - Magnets:
-    - American Magnetics AMI430; allow a broader range of field limit values (#1558)
-    - American Magnetics AMI430; fix coil-constant related bug (#1527)
+
+    * American Magnetics AMI430; allow a broader range of field limit values (#1558)
+    * American Magnetics AMI430; fix coil-constant related bug (#1527)
 
   - Multimeters:
-    - Tektronix Keithley 6500; allow immediate triggering (#1576)
-    - Tektronix Keithley 6500; fix invalid SCPI commands (#1541)
+
+    * Tektronix Keithley 6500; allow immediate triggering (#1576)
+    * Tektronix Keithley 6500; fix invalid SCPI commands (#1541)
 
   - Source Meters:
-    - Tektronix Keithley 2450; add brand new driver! (#1533, #1569)
+
+    * Tektronix Keithley 2450; add brand new driver! (#1533, #1569)
+
   - Vector Generators:
-    - Keysight E8267D; extend frequency modulation features (#1554)
+
+    * Keysight E8267D; extend frequency modulation features (#1554)
 
   - Vector Network Analyzers:
-    - Rohde&Schwarz ZNB; make initialization more fail-safe (#1564)
+
+    * Rohde&Schwarz ZNB; make initialization more fail-safe (#1564)
 
   - Others:
-    - Mj2; allow higher gain (#1575)
-    - Cryocon; allow the setting of the termination character (#1559)
+
+    * Mj2; allow higher gain (#1575)
+    * Cryocon; allow the setting of the termination character (#1559)
 
 - Data Saving Features:
 
@@ -58,11 +69,13 @@ as well a handful of driver improvements and some new data saving functionalitie
 
   - Extend QCoDeS-Station to be configurable through yaml file (#1560)
 
-## Breaking Changes
+Breaking Changes:
+_________________
 
 - The DataSet no longer has an `add_parameter` method (#1547)
 
-## Miscellaneous
+Miscellaneous:
+______________
 
 - The python package dependencies have been updated (#1550)
 - Our copyright is up to date :) (#1552)
diff --git a/docs/changes/0.4.0.rst b/docs/changes/0.4.0.rst
@@ -6,26 +6,32 @@ complex-valued data, includes under-the-hood improvements, and
 ships a couple of new instrument drivers as well as
 improvements to existing instrument drivers.
 
-## New & Improved
+New & Improved:
+_______________
 
 - Native support for complex-valued data:
 
   - Support for plotting complex-valued datasets in `plot_by_id` (#1592)
   - Reorg Parameter notebooks and add basic complex numbers notebook (#1568)
 
 - QCoDeS Workflow:
+
   - Add `plot_dataset` function to plot given data set without specifying id as in `plot_by_id` (#1614)
 
 - Instruments
+
   - Fix / snapshot_base `params_to_skip_update` behavior (#1584)
 
 - Database upgrades:
+
   - DB version 6 - version contents of `run_description` column (#1577)
 
 - Old dataset:
+
   - Change `HDF5FormatMetadata` to not sort keys in the metadata (#1581)
 
-## Instrument drivers
+Instrument drivers:
+___________________
 
 - New Drivers:
 
@@ -50,11 +56,13 @@ improvements to existing instrument drivers.
     - D5a: Add `set_dac_unit` method (#1582)
     - D5a: Updating vals when unit is updated (#1589)
 
-## Miscellaneous
+Miscellaneous:
+______________
 
 - Documentation: Explicit experiment in notebooks (#1612)
 
-## Under the hood
+Under the hood:
+_______________
 
 - Use perf_counter, not monotonic for DB flushing (#1498)
 - Don't get db location from config if sqlite connection supplied (#1618)
diff --git a/docs/changes/0.5.0.rst b/docs/changes/0.5.0.rst
@@ -0,0 +1,63 @@
+Changelog for QCoDeS 0.5.0
+==========================
+
+The July 2019 release of QCoDeS
+
+New:
+____
+
+- `ElapsedTimeParameter` (#1629)
+- `load_by_run_spec` enables to load data set given run specifications, including the `run_id` (#1637)
+- Linking runs (#1639)
+- allow parameters to be excluded from snapshot (#1653)
+
+Improved:
+_________
+
+- improved docs
+
+   * JSON serializability of snapshot (#1627)
+   * Tektronix AWG 7000/5028 resolution docstring (#1628)
+   * m4i docstrings (#1638)
+   * Configuring QCoDeS, Station notebooks (#1630)
+
+- installed QCoDeS package marked as safe for type checking (#1634)
+- log installation info (#1648)
+- allow for using application insight for telemetry (#1648)
+- fix bug in `on_off_mapping` (#1655)
+- use Conda 4.7 (#1635), numpy 1.16.4, matplotlib 3.1 (#1643), sphinx 2.1.2 (#1609), mypy 0.720 (#1640)
+- export data to `.dat` file (#1646)
+
+New Instrument drivers:
+_______________________
+
+- Keysight N6705B (#1657)
+
+
+Improved Drivers:
+_________________
+
+- KeithleyS46 (#1622)
+  add method to check whether channel is closed.
+  Example: `s46.A1.is_closed()`
+- Tektronix AWG5014 (#1626)
+  Fixed validators
+- Spectrum M4i add `exact_sample_rate` parameter (#1654)
+- Tektronix DPO7200XX (#1656)
+  measurement statistics, measurement state
+- Oxford Triton (#893)
+  Add magnet control
+- Spectrum m4i (#1528)
+  fix bug in averaging blockavg
+
+Under the hood:
+_______________
+
+- Stop redundantly writing to `layouts` and `dependencies` (using `run_description` instead) (#1572)
+- reorganizing `sqlite_base.py` to facilitytate legacy database creation (#1570)
+- Base Sphinx makefiles on the modern template (#1636)
+- Build travis against all branches (#1644)
+- Deploy docs using Azure rather than Travis (#1647)
+- Docsbuild: remove old files before checking in and use old style message (#1649)
+- Change HDF5FormatMetadata to not sort keys in the metadata (#1581)
+
diff --git a/docs/changes/index.rst b/docs/changes/index.rst
@@ -16,3 +16,4 @@ Changelogs
    0.2.1 <0.2.1>
    0.3.0 <0.3.0>
    0.4.0 <0.4.0>
+   0.5.0 <0.5.0>
