.. The Zaber Serial Library in Python documentation master file, created by
   sphinx-quickstart on Thu Mar 19 13:06:09 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

The Zaber Serial Library in Python
==================================

Introduction
------------

The Zaber Serial Library is a small Python library for communicating with Zaber
devices over a serial port. It is built on top of `PySerial`_.

The library is compatible with Python 2.7 and 3.4. It is released under the
`Apache License`_.

.. _`PySerial`: https://github.com/pyserial/pyserial
.. _`Apache License`: http://apache.org/licenses/LICENSE-2.0

Contents
--------

.. toctree::
   :maxdepth: 3
   
   getting-started
   examples
   advanced-topics
   zaber.serial

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

The Zaber Serial Library can be installed from the `Python Package Index`_
using ``pip``::

    pip install zaber.serial

Once the installation finishes, you can use the library by importing it in any
Python file::
    
    import zaber.serial

Or directly import just the classes you want::
    
    from zaber.serial import AsciiSerial, AsciiDevice, AsciiCommand

.. _`Python Package Index`: https://pypi.python.org/pypi

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`