Overall Status
master branch status |
|
GitHub status |
|
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 |
2023 Q1.1 |
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.4.6
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 {0}, record {1} samples acquired: {2:,}\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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file niscope-1.4.6.tar.gz.
File metadata
- Download URL: niscope-1.4.6.tar.gz
- Upload date:
- Size: 100.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cadb120820c4e531e8dda4751e6bfe6e81838130559a1be94ad18e0361b64246
|
|
| MD5 |
0cdd979ecbddbc32bd2fdbdbe8176dac
|
|
| BLAKE2b-256 |
bb78fd6df870a61dd77e195770e7622cad147ed1f50fd881fbbe5d9ada4337ff
|
File details
Details for the file niscope-1.4.6-py3-none-any.whl.
File metadata
- Download URL: niscope-1.4.6-py3-none-any.whl
- Upload date:
- Size: 102.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b993cf0f1b36605398c5cc879c875eabd95ca44b2738a0265453431a6bdc9901
|
|
| MD5 |
a8f9e12e4b129566c7c7e941fc65b78e
|
|
| BLAKE2b-256 |
f8d301113056f238ce06e7a1c5d7f7b689dcdf0250ab4d998c334fd9f84f2ae8
|
