VeriStand Python Documentation

Info	VeriStand Python Support
Author	National Instruments

About

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

Requirements

niveristand requires the following to be installed:

VeriStand 2021 or later
CPython 3.8 or later (the standard Python, available on python.org and elsewhere)

Recommended

NI recommends you use an editor with code completion, such as Visual Studio Code, to make it easier to browse and use this code.

Installation

To install niveristand, use one of the following methods:

pip:
```
$ python -m pip install niveristand
```
easy_install from setuptools:
```
$ python -m easy_install niveristand
```
Download the project source and run the following script:
```
$ python setup.py install
```

Usage

Refer to the System Definition Examples section for detailed examples of how to script a system definition file.

Refer to the Basic Real-time Sequence Examples section for detailed information on how to write a Python real-time sequence.

Support / Feedback

The niveristand package is supported by NI. For support for niveristand, open a request through the NI support portal at ni.com.

Bugs / Feature Requests

To report a bug or submit a feature request, please use the GitHub issues page.

Documentation

To view the documentation, visit the VeriStand Python Documentation Page.

Additional Documentation

Refer to the VeriStand Help for detailed information on setting up a system and running real-time test scenarios.

VeriStand Help installs only with the full version of VeriStand.

License

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

User Documentation: