Skip to main content

NI-ModInst Python API

Project description

Overall Status

master branch status

Build Status - master branch MIT License Test Coverage - master branch

GitHub status

Open Issues + Pull Requests Open Pull Requests


Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.




The nimodinst module provides a Python API for NI-ModInst. The code is maintained in the Open Source repository for nimi-python.

Support Policy

nimodinst supports all the Operating Systems supported by NI-ModInst.

It follows Python Software Foundation support policy for different versions of CPython.

NI-ModInst Python API Status

NI-ModInst (nimodinst)

Driver Version Tested Against

2023 Q2

PyPI Version

Latest NI-ModInst Version

Supported Python Version

NI-ModInst supported Python versions


NI-ModInst Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-ModInst

Open Pull Requests

Pull Requests for NI-ModInst


As a prerequisite to using the nimodinst module, you must install the NI-ModInst runtime on your system. Visit to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-ModInst) can be installed with pip:

$ python -m pip install nimodinst~=1.4.6


We welcome contributions! You can clone the project repository, build it, and install it by following these instructions.


The following is a basic example of using the nimodinst module to retrieve information on all High Speed Digitizers currently in the system.

import nimodinst
with nimodinst.Session("niscope") as session:
    for device in session:
        print("{: >20} {: >15} {: >10}".format(device.device_name, device.device_model, device.serial_number))

Other usage examples can be found on GitHub.

Support / Feedback

For support specific to the Python API, follow the processs in Bugs / Feature Requests. For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit NI Community Forums.

Bugs / Feature Requests

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

Fill in the issue template as completely as possible and we will respond as soon as we can.


Documentation is available here.


nimi-python 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.

gRPC Features

For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is subject to the NI General Purpose EULA (see NILICENSE).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nimodinst-1.4.6.tar.gz (17.4 kB view hashes)

Uploaded source

Built Distribution

nimodinst-1.4.6-py3-none-any.whl (17.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page