============================
Introduction to Python VXI11
============================

Overview
========
This Python package supports the VXI-11 Ethernet instrument control protocol
for controlling VXI11 and LXI compatible instruments.  The implementation is
pure Python and highly portable.  

It is released under the MIT license, see LICENSE_ for more
details.

Copyright (C) 2012-2013 Alex Forencich <alex@alexforencich.com>

See also:

- `Python VXI11 home page`_
- `GitHub repository`_

.. _LICENSE: appendix.html#license
.. _`Python VXI11 home page`: http://alexforencich.com/wiki/en/python-vxi11/start
.. _`GitHub repository`: https://github.com/alexforencich/python-vxi11


Features
========
- Supports Python 2 and Python 3
- Pure Python
- Highly portable
- Communicates with instruments over the VXI11 TCP/IP instrument control protocol

Requirements
============
- Python 2 or Python 3


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

To install the module for all users on the system, administrator rights (root)
are required.

From source
~~~~~~~~~~~
Download the archive, extract, and run::

    python setup.py install

Packages
~~~~~~~~
There are also packaged versions for some Linux distributions:

Arch Linux
    Python VXI11 is available under the name "python-vxi11-git" in the AUR.

