Skip to main content

NI-SCOPE 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 niscope module provides a Python API for NI-SCOPE. The code is maintained in the Open Source repository for nimi-python.

Support Policy

niscope supports all the Operating Systems supported by NI-SCOPE.

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

NI-SCOPE Python API Status

NI-SCOPE (niscope)

Driver Version Tested Against

2025 Q1

PyPI Version

Latest NI-SCOPE Version

Supported Python Version

NI-SCOPE supported Python versions

Documentation

NI-SCOPE Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-SCOPE

Open Pull Requests

Pull Requests for NI-SCOPE

Installation

As a prerequisite to using the niscope module, you must install the NI-SCOPE runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.

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

$ python -m pip install niscope~=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 niscope module to open a session to a High Speed Digitizer and capture a single record of 1000 points.

import niscope
with niscope.Session("Dev1") as session:
    session.channels[0].configure_vertical(range=1.0, coupling=niscope.VerticalCoupling.AC)
    session.channels[1].configure_vertical(range=10.0, coupling=niscope.VerticalCoupling.DC)
    session.configure_horizontal_timing(min_sample_rate=50000000, min_num_pts=1000, ref_position=50.0, num_records=5, enforce_realtime=True)
    with session.initiate():
        waveforms = session.channels[0,1].fetch(num_records=5)
    for wfm in waveforms:
        print('Channel {}, record {} samples acquired: {:,}\n'.format(wfm.channel, wfm.record, len(wfm.samples)))

    # Find all channel 1 records (Note channel name is always a string even if integers used in channel[])
    chan1 = [wfm for wfm in waveforms if wfm.channel == '0']

    # Find all record number 3
    rec3 = [wfm for wfm in waveforms if wfm.record == 3]

If you need faster fetch performance, or to directly interface with SciPy, you can use the fetch_into() method instead of fetch(). See the fetch_into example.

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

niscope-1.4.9.tar.gz (100.4 kB view details)

Uploaded Source

Built Distribution

niscope-1.4.9-py3-none-any.whl (102.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for niscope-1.4.9.tar.gz
Algorithm Hash digest
SHA256 e85493c9d3f707fac1b280352ea2c1cacd71fd733d6faf9a22a05853492fe87a
MD5 cf9d654a47bcbd80df8cfb1668ee032a
BLAKE2b-256 afe2adc3daf7e0ad8561c8c9e34ca373f6879fba7ff3ffd8833ec9b61cf00da7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for niscope-1.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0b03f1e665ef22ba614defc476149500bc6ddf20e64534476d7496b4f58b30c0
MD5 7dd5bd7887cca78ec54cd044c2f30dbb
BLAKE2b-256 0b228e1149f29a614a66c0ed832e9a8bf6bbe40461bb91475bafbafe7d276112

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