Fix spelling mistakes caught by sphinx-spelling

sphinxcontrib-spelling to docs/requirements

.github/workflows/docs.yml

@@ -37,12 +37,19 @@ jobs:
           sudo dpkg -i pandoc-2.18-1-amd64.deb
           cd docs && make html EXAMPLE_SRC=remote
 
-      - name: "Test spelling docs"
-        run: |
-          cd docs && sphinx-build -b spelling -q source build/spelling
-
       - name: Store artifacts
         uses: actions/upload-artifact@v2
         with:
           name: docs
           path: docs/build/html
+
+      - name: "Test spelling docs"
+        run: |
+          cd docs && sphinx-build -b spelling -q -W --keep-going source build/spelling
+
+      - name: Store spelling result artifacts
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: docs-spelling-failure-report
+          path: docs/build/spelling

CHANGELOG.md

@@ -20,7 +20,7 @@
 ## Version 0.3.2
 * Added a helper function ``uhfqa.qas[n].integration.write_integration_weights`` for
   QAS integration weights configuration
-* Bugfix: Adapt nodetree to be able to get daq result data #113
+* Bugfix: Adapt Node Tree to be able to get daq result data #113
 * Bugfix: in the ``Waveform`` class to be able to convert a single waveform into
   a complex waveform.
 * Bugfix: HF2 PID nodes are available.
@@ -30,7 +30,7 @@
 * pqsc.check_zsync_connection blocks even if nothing is connected
 * Create a temporary awg module every time a sequencer code is uploaded
   (The reason for it is to have de defined state) #104
-* reintroduce uhfqa.qa_deleay function
+* reintroduce uhfqa.qa_delay function
 * uhfli/uhfqa return node object for ``uhfli.awg`` instead of raising an error
   (necessary for qcodes drivers) #102
 * ``hdawg.enable_qccs_mode`` wrong reference clock source fixed
@@ -47,17 +47,17 @@
 * Improved testing with mocking
 
 ## Version 0.2.4
-* Adapt modulation frequence range to +-1GHz
+* Adapt modulation frequency range to +-1GHz
   (shfsg.sgchannels[i].modulation_freq, shfqa.qachannels[i].sweeper.oscillator_freq)
-* Bugfix: DAQ module timout exception raises AttributeError
+* Bugfix: DAQ module timeout exception raises AttributeError
 
 ## Version 0.2.3
 * Make the command table validation optional
 
 ## Version 0.2.2
 * SHFQA Adapt oscillator_freq to +-500e6 Hz
 * Initial support for SHFSG
-* Make nodetree generation case insensitive
+* Make Node Tree generation case insensitive
 
 ## Version 0.2.1
 * Bugfix #86
@@ -103,6 +103,4 @@
 * minor fixes and additions
 
 ## Version 0.1.0
-* Intial release
-
-
+* Initial release

docs/make.bat

@@ -7,17 +7,17 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+
 set SOURCEDIR=source
 set BUILDDIR=build
 set EXAMPLE_SRC=%2
 
-if %2 == "" (
+if "%2" == "" (
 	set EXAMPLE_SRC=local
 )
 
 if "%1" == "" goto help
 
-
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.

docs/requirements.txt

@@ -7,4 +7,5 @@ pydata_sphinx_theme<0.9.0 # TODO: Custom CSS/templates do not work with newest v
 sphinx_autodoc_typehints
 jupytext==1.13.7
 ipython
-requests
+requests
+sphinxcontrib-spelling

docs/source/examples/common_device.rst

@@ -40,8 +40,8 @@ access the node specific information.
      /dev3036/demods/0/oscselect,
      ...]
 
-The node tree is automatically generated during the initialisation of the device
-in toolkit. It is based on the information provided by the device and therfore
+The node tree is automatically generated during the initialization of the device
+in toolkit. It is based on the information provided by the device and therefore
 adapts automatically to a new firmware.
 
 Check Compatibility
@@ -53,14 +53,14 @@ if not all versions are up to date important feature or fixes by be missing.
 To ensure that all versions match each device exposes a function called
 ``check_compatibility`` which only passes if all versions match.
 
-The following criterias are checked:
+The following criteria are checked:
 
 * minimum required zhinst-deviceutils package is installed
 * minimum required zhinst-ziPython package is installed
 * zhinst package matches the LabOne Data Server version
 * firmware revision matches the LabOne Data Server version¨
 
-If any of the above criterias is not fullfilled ``check_compatibility`` will
+If any of the above criterion is not fulfilled ``check_compatibility`` will
 raise RuntimeError.
 
 Transactional Set
@@ -97,7 +97,7 @@ Factory reset
 -------------
 
 To reset a device to the factory settings LabOne has a default preset. All
-toolkit device classes therfor expose a function called ``factory_reset`` which
+toolkit device classes therefor expose a function called ``factory_reset`` which
 loads the default preset.
 
 .. code-block:: python
@@ -109,5 +109,5 @@ loads the default preset.
 
     Not all devices support the factory devices yet. If a device does not support
     the factory reset it will issue a warning when trying to call it. In that
-    case a powercycle has the same effect.
+    case a power cycle has the same effect.
 

docs/source/examples/pqsc.rst

@@ -12,12 +12,12 @@ tune-up and error correction adapted to the specific algorithm and computer
 architecture in use.
 
 Please refer to the `user manual <http://docs.zhinst.com/pqsc_user_manual/overview.html>`_
-for an indepth explanation of all features.
+for an in-depth explanation of all features.
 
 Like every device the device specific settings and data is organized in a path
 like structure called the node tree. zhinst-toolkit provides a pythonic way of
 interacting with this node tree. For more information about all functionalities
-and usage of the node tree in toolkit refer to the deditacted
+and usage of the node tree in toolkit refer to the dedicated
 :doc:`section <../first_steps/nodetree>`.
 
 zhinst-toolkit offers the following helper functions for the PQSC:

docs/source/examples/shfqa.rst

@@ -7,12 +7,12 @@ to 8.5 GHz, and up to 4 readout channels that can faithfully discriminate up to
 16 qubits, 8 qutrits or 5 ququads.
 
 Please refer to the `user manual <http://docs.zhinst.com/shfqa_user_manual/overview.html>`_
-for an indepth explanation of all features.
+for an in-depth explanation of all features.
 
 Like every device the device specific settings and data is organized in a path
 like structure called the node tree. zhinst-toolkit provides a pythonic way of
 interacting with this node tree. For more information about all functionalities
-and usage of the node tree in toolkit refer to the deditacted :doc:`section <../first_steps/nodetree>`.
+and usage of the node tree in toolkit refer to the dedicated :doc:`section <../first_steps/nodetree>`.
 
 The package ``zhinst-deviceutils`` provided by Zurich Instruments offers a
 collection of helper functions to ease the use of the SHFQA among other devices.
@@ -24,7 +24,7 @@ the equivalent functions in zhinst-toolkit.
    :widths: 25 25 50
    :header-rows: 1
 
-   * - zhinst-devieutils
+   * - zhinst-deviceutils
      - zhinst-toolkit
      - info
    * - start_continuous_sw_trigger()

docs/source/examples/shfsg.rst

@@ -9,24 +9,24 @@ system tune-up. Each SHFSG comes with 4 or 8 analog output channels with 14-bit
 vertical resolution.
 
 Please refer to the `user manual <http://docs.zhinst.com/shfsg_user_manual/overview.html>`_
-for an indepth explanation of all features.
+for an in-depth explanation of all features.
 
 Like every device the device specific settings and data is organized in a path
 like structure called the node tree. zhinst-toolkit provides a pythonic way of
 interacting with this node tree. For more information about all functionalities
-and usage of the node tree in toolkit refer to the deditacted :doc:`section <../first_steps/nodetree>`.
+and usage of the node tree in toolkit refer to the dedicated :doc:`section <../first_steps/nodetree>`.
 
 The package ``zhinst-deviceutils`` provided by Zurich Instruments offers a
 collection of helper functions to ease the use of the SHFSG among other devices.
-Toolkit embedds these functions inside the nodetree. The follwoing table shows
+Toolkit embeds these functions inside the nodetree. The following table shows
 the equivalent functions in zhinst-toolkit.
 
 
 .. list-table::
    :widths: 25 25 50
    :header-rows: 1
 
-   * - zhinst-devieutils
+   * - zhinst-deviceutils
      - zhinst-toolkit
      - info
    * - **sgchannel**

docs/source/examples/uhfqa.rst

@@ -11,12 +11,12 @@ UHFQA supports the development of ambitious quantum computing projects for 100
 qubits and more.
 
 Please refer to the `user manual <http://docs.zhinst.com/uhfqa_user_manual/overview.html>`_
-for an indepth explanation of all features.
+for an in-depth explanation of all features.
 
 Like every device the device specific settings and data is organized in a path
 like structure called the node tree. zhinst-toolkit provides a pythonic way of
 interacting with this node tree. For more information about all functionalities
-and usage of the node tree in toolkit refer to the deditacted
+and usage of the node tree in toolkit refer to the dedicated
 :doc:`section <../first_steps/nodetree>`.
 
 zhinst-toolkit offers the following helper functions for the UHFQA:

docs/source/first_steps/installation.rst

@@ -17,10 +17,10 @@ These distributions will be installed automatically when installing zhinst-toolk
   functions to operate on these arrays.
 * `jsonschema <https://pypi.org/project/jsonschema/>`_ is an implementation of the JSON
   Schema specification for Python.
-* `zhinst <https://pypi.org/project/zhinst/>`_ is the low level python api for Zurich
+* `zhinst <https://pypi.org/project/zhinst/>`_ is the low level python API for Zurich
   Instruments devices.
 * `zhinst-deviceutils <https://pypi.org/project/zhinst-deviceutils/>`_ is a collection
-  of helper functions for the LabOne® python api.
+  of helper functions for the LabOne® python API.
 
 Install zhinst-toolkit
 ----------------------

docs/source/index.rst

@@ -6,14 +6,14 @@
 |
 
 Zurich Instruments Toolkit |version| Documentation
-===================================================
+==================================================
 
 zhinst-toolkit is a high level driver package that allows communication with
 Zurich Instruments devices from the Python programming language. It is based on
 top of the native `Python API <https://pypi.org/project/zhinst/>`_
 (``zhinst.ziPython``) of LabOne®, the Zurich Instruments control software.
 
-The central goal of zhinst-toolkit is to provide a pythonic approach to interact
+The central goal of zhinst-toolkit is to provide a Pythonic approach to interact
 with any Zurich Instruments device and is intended as a full replacement for the
 low level ``zhinst.ziPython`` package.
 

docs/source/spelling_wordlist.txt

@@ -96,4 +96,11 @@ autorange
 Loopback
 gaussian
 upconversion
-clockbase
+clockbase
+demodulator
+transactional
+parsers
+sideband
+crosstalk
+waveforms
+Waveforms

examples/awg.md

@@ -38,7 +38,7 @@ Connect devices and access the ``/awg`` node.
 from zhinst.toolkit import Session
 
 session = Session('localhost')
-device = session.connect_device("DEV8541")
+device = session.connect_device("DEVXXXX")
 awg_node = device.awgs[0]
 ```
 
@@ -67,10 +67,6 @@ waitWave();
 awg_node.load_sequencer_program(SEQUENCER_CODE)
 ```
 
-```python
-session.daq_server.listNodes("/DEV8541/AWGS/0/WAVEFORM")
-```
-
 ```python
 awg_node.enable_sequencer(single=True)
 awg_node.wait_done()
@@ -98,7 +94,7 @@ format take a look at the awg section in the
 zhinst-toolkit itself offers a second, more user friendly approach through the class
 called ``Waveforms``.
 
-The ``Waveform`` class is a mutuable mapping, meaning it behaves similiar to a
+The ``Waveform`` class is a mutable mapping, meaning it behaves similar to a
 Python dictionary. The key defines the waveform index and the value is the waveform
 data provided as a tuple. The waveform data consists of the following elements:
 
@@ -132,7 +128,7 @@ awg_node.write_to_waveform_memory(waveforms)
 >
 > The waveform data can also be assigned via the helper function
 > ``assign_waveform`` which converts the data into the same tuple
-> as used above. Similiar ``assign_native_awg_waveform`` can be used to
+> as used above. Similar ``assign_native_awg_waveform`` can be used to
 > assign already to a single native AWG format array converted waveform data to
 > an index.
 
@@ -162,10 +158,10 @@ For more information on the usage and advantages of the command table reference
 to the [user manuals](https://docs.zhinst.com/hdawg_user_manual/tutorial_command_table.html#umhd.tutorials.ct.introduction).
 Note that the command table is not supported on all devices that have an AWG.
 
-The command tables is specified in the JSON format and need to comform to a device
+The command tables is specified in the JSON format and need to conform to a device
 specific schema. The user manuals explain in detail how the command table is
 structured and used. Similar to the Waveforms zhinst-toolkit offers a helper class
-for the comman table usage called ``CommandTable``.
+for the command table usage called ``CommandTable``.
 
 > Note:
 >

examples/daq_module.md

@@ -13,7 +13,7 @@ jupyter:
     name: python3
 ---
 
-# DAQ Data Aquisition
+# DAQ Data Acquisition
 
 Example for the Data Acquisition Module. This example demonstrates
 how to record data from an instrument continuously (without triggering).
@@ -36,7 +36,7 @@ from zhinst.toolkit import Session
 import numpy as np
 
 session = Session('localhost')
-device = session.connect_device("dev3036")
+device = session.connect_device("DEVXXXX")
 ```
 
 ### General configuration

examples/hf2.md

@@ -21,10 +21,10 @@ developed by Zurich Instruments. Since the initial release of the HF2 a lot more
 Instruments have joined the family of Zurich Instrument and the features of
 LabOne where constantly upgraded. Never the less the HF2LI offers exceptional
 features and measurement performance and is of course still fully supported by
-LabOne and zhinst-toolkit. However it has a few specialities like a seperate
+LabOne and zhinst-toolkit. However it has a few specialties like a separate
 Data Sever or the maximal support of API level 1.
 
-Never the less toolkit offers a similiar handling of the HF2 compared to other
+Never the less toolkit offers a similar handling of the HF2 compared to other
 devices. Since the HF2 uses a different data server one can not share a session
 with other devices.
 
@@ -63,9 +63,9 @@ device.demods[0].enable()
 
 ## Polling DEMOD Samples
 
-To get samples for the device subscribe and poll is the prefered way.
+To get samples for the device subscribe and poll is the preferred way.
 After the subscribe command the data server will the node changes in an
-internaly. In case of a sample node the values will be updated by the device in
+internally. In case of a sample node the values will be updated by the device in
 the respective sampling frequency. With the poll command the buffered data can
 be fetched.
 
@@ -193,7 +193,7 @@ print(
 
 ### Plot
 
-#### Bode Diagramm
+#### Bode Diagram
 
 ```python
 import matplotlib.pyplot as plt