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

Info

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

Author

NI

About

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

2025 Q1

PyPI Version

Latest NI-ModInst Version

Supported Python Version

NI-ModInst supported Python versions

Documentation

NI-ModInst Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-ModInst

Open Pull Requests

Pull Requests for NI-ModInst

Installation

As a prerequisite to using the nimodinst module, you must install the NI-ModInst runtime on your system. Visit ni.com/downloads 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.9

Contributing

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

Usage

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

Documentation is available here.

License

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).

Project details


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.9.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

nimodinst-1.4.9-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file nimodinst-1.4.9.tar.gz.

File metadata

  • Download URL: nimodinst-1.4.9.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nimodinst-1.4.9.tar.gz
Algorithm Hash digest
SHA256 e0c64d581466e6d146cd5c20376f2595f7fa1a98ac8cdbed98646d1acd8405b3
MD5 855f9546bbc742337d85486208f083ff
BLAKE2b-256 e834a136d110ce5a68e105127fff2dad7523f9a76d321d48c77a16737eaebf0f

See more details on using hashes here.

File details

Details for the file nimodinst-1.4.9-py3-none-any.whl.

File metadata

  • Download URL: nimodinst-1.4.9-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for nimodinst-1.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d9497c3d2306d543da2f8feb1e0b8f74379169e5543c86520f8f5f2347dfc299
MD5 9dd9026bcf0745be4e4a076f907ecc3f
BLAKE2b-256 22b502c4fd1f9541e648092f20e1aefd41a91780051035fb669ca877160da257

See more details on using hashes here.

Supported by

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