keyoscacquire: Keysight oscilloscope acquire

keyoscacquire is a Python package for acquiring traces from Keysight InfiniiVision oscilloscopes through a VISA interface.

Based on PyVISA, keyoscacquire provides programmes for acquiring and exporting traces to your choice of ASCII format files (default csv) or numpy npy, and a png of the trace plot. The package also provides an API for integration in other Python code.

By default, the package uses the binary WORD format for the waveform transfer from the oscilloscope, giving roughly an order of magnitude speed-up over the ASCII transfer type.

The code has been tested on Windows 7 and 10 with a Keysight DSO2024A model using a USB connection.

Table of contents

User guide

• Overview and getting started
  • Installation
  • Quick reference
  • Known issues and suggested improvements
• How to use
  • Command line programmes for trace export
  • Waveform formats
  • Using the API
  • Note on obtaining traces when the scope is running vs when stopped
  • Default options in keyoscacquire.config
  • Logging
  • Miscellaneous
• Command line programmes
  • list_visa_devices
  • path_of_config
  • get_single_trace
  • get_num_traces
  • get_traces_single_connection
  • get_traces_connect_each_time

Reference/API

• Instrument communication
  • The Oscilloscope class
    • High-level functions
    • Connection and VISA commands
    • Oscilloscope state control
    • Acquisition and transfer properties
    • Multiple acquisition and transfer options setting functions
    • Other
  • The preamble
• Data processing, file saving & loading
  • Data processing (keyoscacquire.dataprocessing)
  • File saving and loading (keyoscacquire.fileio)
• Python backend for command line programmes
• Configuration module config
• Visa-related support module visa_utils

Project docs

• Changelog
  • v4.0: Extreme (API) makeover
  • v3.0: Docs are overrated
  • v2.1: May I have your address?
  • v2.0: Labels for everyone
  • v1.1: Need for speed
  • v1.0: Hello world
• Known issues and suggested improvements
• License
• GitHub repository

Building a local copy of the docs

Should you wish to build a local copy of the sphinx docs, make sure the necessary packages are installed:

pip install sphinx sphinx-prompt furo recommonmark

and then build by executing make html in the docs folder.

License

The project is licensed under the MIT license, see License.

Contribute/report issues

Please report any issues with the package with the issue tracker on Github.

Contributions are welcome via Github.

The package is written and maintained by Andreas Svela.