niveristand 0.9.0

NI VeriStand Python API

=========== =================================================================================================================================
Info NI VeriStand Python Support
Author National Instruments
=========== =================================================================================================================================

.. _about_section:

About
=====
The **niveristand** package contains an API (Application Programming Interface) that interacts with NI VeriStand systems.
The package is implemented in Python. NI created and supports this package.

Requirements
============
**niveristand** |version| has the following requirements:

* NI VeriStand 2018 running on the same system as the Python code.
* 64-bit version of Windows 10/8.1/7
* CPython 2.7 or 3.5+

.. _installation_section:

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

To install **niveristand**, use one of the following methods:

1. `pip <http://pypi.python.org/pypi/pip>`_::

$ python -m pip install niveristand
2. **easy_install** from `setuptools <http://pypi.python.org/pypi/setuptools>`_::

$ python -m easy_install niveristand
3. Download the project source and run the following script::

$ python setup.py install

.. _usage_section:

Usage
=====
Refer to :doc:`basic_examples` for detailed information on how to write a Python real-time sequence.

.. _support_section:

Support / Feedback
==================

The **niveristand** package is supported by NI. For support for **niveristand**, open
a request through the NI support portal at `ni.com <http://www.ni.com>`_.

Bugs / Feature Requests
=======================

To report a bug or submit a feature request, please use the
`GitHub issues page <https://github.com/ni/niveristand-python/issues>`_.

Documentation
=============

To view the documentation, visit the `NI VeriStand Python Documentation Page <http://niveristand-python.readthedocs.io>`_.

Additional Documentation
========================

Refer to the `NI VeriStand Help <http://digital.ni.com/express.nsf/bycode/ex9v46>`_
for detailed information on setting up a system and running real-time test scenarios.

NI VeriStand Help installs only with the full version of NI VeriStand.

License
=======

**niveristand** is licensed under an MIT-style license (see `LICENSE
<LICENSE>`_). Other incorporated projects may be licensed under different
licenses. All licenses allow for non-commercial and commercial use.