Metadata-Version: 2.4
Name: tektronixsg
Version: 0.2.0
Summary: Interface for Tektronix signal generators.
Author-email: Kevin Koch <kevink2@mail.uni-paderborn.de>
License-Expression: BSD-3-Clause
Project-URL: Repository, https://github.com/emtpb/tektronixsg/
Project-URL: Issues, https://github.com/emtpb/tektronixsg/issues
Project-URL: Changelog, https://github.com/emtpb/tektronixsg/blob/master/CHANGELOG.rst
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pyvisa
Requires-Dist: pyvisa-py; sys_platform == "linux"
Requires-Dist: pyusb; sys_platform == "linux"
Provides-Extra: doc
Requires-Dist: setuptools_scm; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

************************************
Tektronix Signal Generator Interface
************************************

Interface for Tektronix signal generators.


Features
========

* Support basic functions for model AFG31052
* Support basic functions for model AFG1022


Installation
============

To install the Tektronix Signal Generator Interface, run this command in your terminal::

   $ pip install tektronixsg

Note that usage in Windows will require a driver, for example the `IO Libraries Suite`_ by Keysight.


Usage
=====

Example how to use tektronixsg::

   from tektronixsg import SignalGenerator
   sg = SignalGenerator()
   # Set the voltage amplitude of the first channel to 1V
   sg.channels[0].voltage_amplitude = 1
   # Set the signal type of the first channel to sine
   sg.channels[0].signal_type = "sine"
   # Set the frequency of the first channel to 100 kHz
   sg.channels[0].frequency = 1e5
   # Enable the output of the first channel
   sg.channels[0].output_on = True


.. _IO Libraries Suite: https://www.keysight.com/us/en/lib/software-detail/computer-software/io-libraries-suite-downloads-2175637.html
