Metadata-Version: 2.1
Name: instrumentkit
Version: 1.0.0.dev1
Summary: Test and measurement communication library
Home-page: https://www.github.com/instrumentkit/InstrumentKit
Author: Steven Casagrande
Author-email: stevencasagrande@gmail.com
License: AGPLv3
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Manufacturing
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/x-rst
Provides-Extra: numpy
Provides-Extra: dev

InstrumentKit
=============

.. image:: https://github.com/instrumentkit/InstrumentKit/workflows/Testing/badge.svg?branch=main
    :target: https://github.com/instrumentkit/InstrumentKit
    :alt: Github Actions build status

.. image:: https://codecov.io/gh/instrumentkit/InstrumentKit/branch/main/graph/badge.svg?token=Q2wcdW3t4A
    :target: https://codecov.io/gh/instrumentkit/InstrumentKit
    :alt: Codecov code coverage

.. image:: https://readthedocs.org/projects/instrumentkit/badge/?version=latest
    :target: https://readthedocs.org/projects/instrumentkit/?badge=latest
    :alt: Documentation

.. image:: https://img.shields.io/pypi/v/instrumentkit.svg?maxAge=86400
    :target: https://pypi.python.org/pypi/instrumentkit
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/instrumentkit.svg?maxAge=2592000
    :alt: Python versions

InstrumentKit is an open source Python library designed to help the
end-user get straight into communicating with their equipment via a PC.
InstrumentKit aims to accomplish this by providing a connection- and
vendor-agnostic API. Users can freely swap between a variety of
connection types (ethernet, gpib, serial, usb) without impacting their
code. Since the API is consistent across similar instruments, a user
can, for example, upgrade from their 1980's multimeter using GPIB to a
modern Keysight 34461a using ethernet with only a single line change.

Supported means of communication are:

- Galvant Industries GPIBUSB adapter (``open_gpibusb``)
- Serial (``open_serial``)
- Sockets (``open_tcpip``)
- VISA (``open_visa``)
- Read/write from unix files (``open_file``)
- USBTMC (``open_usbtmc``)
- VXI11 over Ethernet (``open_vxi11``)
- Raw USB (``open_usb``)

There is planned support for HiSLIP someday, but a good Python HiSLIP library will be needed first.

If you have any problems or have code you wish to contribute back to the
project please feel free to open an issue or a pull request!

Installation
------------

The ``instruments`` package can be installed from this repository by the
following means:

From Git:

.. code-block:: console

    $ git clone git@github.com:instrumentkit/InstrumentKit.git
    $ cd InstrumentKit
    $ python setup.py install

From Github using pip:

.. code-block:: console

    $ pip install -e git+https://www.github.com/instrumentkit/InstrumentKit.git#egg=instrumentkit

From pypi using pip:

.. code-block:: console

    $ pip install instrumentkit


Usage Example
-------------

To open a connection to a generic SCPI-compatible multimeter using a Galvant
Industries' GPIBUSB adapter:

.. code-block:: python

    >>> import instruments as ik
    >>> inst = ik.generic_scpi.SCPIMultimeter.open_gpibusb("/dev/ttyUSB0", 1)

From there, various built-in properties and functions can be called. For
example, the instrument's identification information can be retrieved by
calling the name property:

.. code-block:: python

    >>> print(inst.name)

Or, since in the demo we connected to an ``SCPIMultimeter``, we can preform
multimeter-specific tasks, such as switching functions, and taking a
measurement reading:

.. code-block:: python

    >>> reading = inst.measure(inst.Mode.voltage_dc)
    >>> print(f"Value: {reading.magnitude}, units: {reading.units}")

Due to the sheer number of commands most instruments support, not every single
one is included in InstrumentKit. If there is a specific command you wish to
send, one can use the following functions to do so:

.. code-block:: python

    >>> inst.sendcmd("DATA") # Send command with no response
    >>> resp = inst.query("*IDN?") # Send command and retrieve response

Python Version Compatibility
----------------------------

At this time, Python 3.6, 3.7, 3.8, 3.9, and 3.10 are supported. Should you encounter
any problems with this library that occur in one version or another, please
do not hesitate to let us know.

Documentation
-------------

You can find the project documentation at our ReadTheDocs pages located at
http://instrumentkit.readthedocs.org/en/latest/index.html

Contributing
------------

The InstrumentKit team always welcome additional contributions to the project.
However, we ask that you please review our contributing developer guidelines
which can be found in the documentation. We also suggest that you look at
existing classes which are similar to your work to learn more about the
structure of this project.

To run the tests against all supported version of Python, you will need to
have the binary for each installed. The easiest way to accomplish this is
to use the tool `pyenv<https://github.com/pyenv/pyenv>_`.

With the required system packages installed, all tests can be run with ``tox``:

.. code-block:: console

    $ pip install tox
    $ tox

Pre-commit
----------

A variety of static code checks are managed and executed via the tool
`pre-commit<https://pre-commit.com/>_`. This only needs to be setup once
and then it'll manage everything for you.

.. code-block:: console

    $ pip install pre-commit
    $ pre-commit install

Afterwards, when you go to make a git commit, all the plugins (as specified
by the configuration file ``.pre-commit-config.yaml``) will be executed against
the files that have changed. If any plugins make changes to the files, the
commit will abort, allowing you to add those changes to your changeset and
try to commit again. This tool will gate CI, so be sure to let them run
and pass!

You can also run all the hooks against all the files by directly calling
pre-commit, or though the ``tox`` environment:

.. code-block:: console

    $ pre-commit run --all

or

.. code-block:: console

    $ tox -e precommit

See the ``pre-commit`` documentation for more information.

License
-------

All code in this repository is released under the AGPL-v3 license. Please see
the ``license`` folder for more information.
