Overall Status
master branch status |
|
GitHub status |
|
Info |
NI Modular Instrument driver APIs for Python. |
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 created and supports niscope.
NI-SCOPE Python API Status
NI-SCOPE (niscope) |
|
|---|---|
Driver Version Tested Against |
2026 Q3 |
PyPI Version |
|
Supported Python Version |
|
Documentation |
|
Open Issues |
|
Open Pull Requests |
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.5.0
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).
5 maintainers
Release files for niscope 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| niscope-1.5.0.tar.gz | 98.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| niscope-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 198.7 kB
Release files / niscope-1.5.0.tar.gz
| Download URL | niscope-1.5.0.tar.gz |
|---|---|
| Size | 98.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
adb1beb231839f4cd48b68b908a68f7ebfb88310d94fe3539e5cdd7b0216f161
|
|
BLAKE2b-256 checksum How to use checksums |
60933ece8b0693930f0e0af8c2eb66b37feac438af378d576799d41689c150f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / niscope-1.5.0-py3-none-any.whl
| Download URL | niscope-1.5.0-py3-none-any.whl |
|---|---|
| Size | 100.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
847a29072a17a2d1cba5af9061e81238a1919e852be7c7479b45ef9c5db7806b
|
|
BLAKE2b-256 checksum How to use checksums |
a0f8238a457de2eeada50f49f35b8ac0ee5e82311aca1241a94e1b4d5f736b4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
