Overall Status
--------------
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
| GitHub status | |OpenIssues| |OpenPullRequests| |
+----------------------+------------------------------------------------------------------------------------------------------------------------------------+
=========== ============================================================================================================================
Info Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.
Author NI
=========== ============================================================================================================================
.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg
:alt: Build Status - master branch
:target: https://travis-ci.org/ni/nimi-python
.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:alt: MIT License
:target: https://opensource.org/licenses/MIT
.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg
:alt: Test Coverage - master branch
:target: https://codecov.io/github/ni/nimi-python
.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg
:alt: Open Issues + Pull Requests
:target: https://github.com/ni/nimi-python/issues
.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg
:alt: Open Pull Requests
:target: https://github.com/ni/nimi-python/pulls
.. _about-section:
About
=====
The **niscope** module provides a Python API for NI-SCOPE. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.
Support Policy
--------------
**niscope** supports all the Operating Systems supported by NI-SCOPE.
It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
NI-SCOPE Python API Status
--------------------------
+-------------------------------+------------------------+
| NI-SCOPE (niscope) | |
+===============================+========================+
| Driver Version Tested Against | 2023 Q4 |
+-------------------------------+------------------------+
| PyPI Version | |niscopeLatestVersion| |
+-------------------------------+------------------------+
| Supported Python Version | |niscopePythonVersion| |
+-------------------------------+------------------------+
| Documentation | |niscopeDocs| |
+-------------------------------+------------------------+
| Open Issues | |niscopeOpenIssues| |
+-------------------------------+------------------------+
| Open Pull Requests | |niscopeOpenPRs| |
+-------------------------------+------------------------+
.. |niscopeLatestVersion| image:: http://img.shields.io/pypi/v/niscope.svg
:alt: Latest NI-SCOPE Version
:target: http://pypi.python.org/pypi/niscope
.. |niscopePythonVersion| image:: http://img.shields.io/pypi/pyversions/niscope.svg
:alt: NI-SCOPE supported Python versions
:target: http://pypi.python.org/pypi/niscope
.. |niscopeDocs| image:: https://readthedocs.org/projects/niscope/badge/?version=latest
:alt: NI-SCOPE Python API Documentation Status
:target: https://niscope.readthedocs.io/en/latest
.. |niscopeOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niscope.svg
:alt: Open Issues + Pull Requests for NI-SCOPE
:target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniscope
.. |niscopeOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/niscope.svg
:alt: Pull Requests for NI-SCOPE
:target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Aniscope
.. _niscope_installation-section:
Installation
------------
As a prerequisite to using the **niscope** module, you must install the NI-SCOPE runtime on your system. Visit `ni.com/downloads <http://www.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 <http://pypi.python.org/pypi/pip>`_::
$ python -m pip install niscope~=1.4.8
Contributing
============
We welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.
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.
.. code-block:: python
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 <https://www.scipy.org/>`_, you can use the **fetch_into()** method instead of **fetch()**. See the fetch_into example.
`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/niscope/examples>`_
.. _support-section:
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 <https://forums.ni.com/>`_.
.. _bugs-section:
Bugs / Feature Requests
=======================
To report a bug or submit a feature request specific to Python API, please use the
`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.
Fill in the issue template as completely as possible and we will respond as soon
as we can.
.. _documentation-section:
Documentation
=============
Documentation is available `here <http://niscope.readthedocs.io>`_.
.. _license-section:
License
=======
**nimi-python** is licensed under an MIT-style license (`see
LICENSE <https://github.com/ni/nimi-python/blob/master/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 <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).
Raw data
{
"_id": null,
"home_page": "https://github.com/ni/nimi-python",
"name": "niscope",
"maintainer": "NI",
"docs_url": null,
"requires_python": null,
"maintainer_email": "opensource@ni.com",
"keywords": "niscope",
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/8d/bf/0ee1a328b7b0dbee5ef13164ae221e0761f4f822bf018b66182dbc0904d6/niscope-1.4.8.tar.gz",
"platform": null,
"description": "Overall Status\n--------------\n\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| master branch status | |BuildStatus| |MITLicense| |CoverageStatus| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n| GitHub status | |OpenIssues| |OpenPullRequests| |\n+----------------------+------------------------------------------------------------------------------------------------------------------------------------+\n\n=========== ============================================================================================================================\nInfo Python bindings for NI Modular Instrument drivers. See `GitHub <https://github.com/ni/nimi-python/>`_ for the latest source.\nAuthor NI\n=========== ============================================================================================================================\n\n.. |BuildStatus| image:: https://api.travis-ci.com/ni/nimi-python.svg\n :alt: Build Status - master branch\n :target: https://travis-ci.org/ni/nimi-python\n\n.. |MITLicense| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :alt: MIT License\n :target: https://opensource.org/licenses/MIT\n\n.. |CoverageStatus| image:: https://codecov.io/github/ni/nimi-python/graph/badge.svg\n :alt: Test Coverage - master branch\n :target: https://codecov.io/github/ni/nimi-python\n\n.. |OpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python.svg\n :alt: Open Issues + Pull Requests\n :target: https://github.com/ni/nimi-python/issues\n\n.. |OpenPullRequests| image:: https://img.shields.io/github/issues-pr/ni/nimi-python.svg\n :alt: Open Pull Requests\n :target: https://github.com/ni/nimi-python/pulls\n\n\n.. _about-section:\n\nAbout\n=====\n\nThe **niscope** module provides a Python API for NI-SCOPE. The code is maintained in the Open Source repository for `nimi-python <https://github.com/ni/nimi-python>`_.\n\nSupport Policy\n--------------\n**niscope** supports all the Operating Systems supported by NI-SCOPE.\n\nIt follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.\n\n\nNI-SCOPE Python API Status\n--------------------------\n\n+-------------------------------+------------------------+\n| NI-SCOPE (niscope) | |\n+===============================+========================+\n| Driver Version Tested Against | 2023 Q4 |\n+-------------------------------+------------------------+\n| PyPI Version | |niscopeLatestVersion| |\n+-------------------------------+------------------------+\n| Supported Python Version | |niscopePythonVersion| |\n+-------------------------------+------------------------+\n| Documentation | |niscopeDocs| |\n+-------------------------------+------------------------+\n| Open Issues | |niscopeOpenIssues| |\n+-------------------------------+------------------------+\n| Open Pull Requests | |niscopeOpenPRs| |\n+-------------------------------+------------------------+\n\n\n.. |niscopeLatestVersion| image:: http://img.shields.io/pypi/v/niscope.svg\n :alt: Latest NI-SCOPE Version\n :target: http://pypi.python.org/pypi/niscope\n\n\n.. |niscopePythonVersion| image:: http://img.shields.io/pypi/pyversions/niscope.svg\n :alt: NI-SCOPE supported Python versions\n :target: http://pypi.python.org/pypi/niscope\n\n\n.. |niscopeDocs| image:: https://readthedocs.org/projects/niscope/badge/?version=latest\n :alt: NI-SCOPE Python API Documentation Status\n :target: https://niscope.readthedocs.io/en/latest\n\n\n.. |niscopeOpenIssues| image:: https://img.shields.io/github/issues/ni/nimi-python/niscope.svg\n :alt: Open Issues + Pull Requests for NI-SCOPE\n :target: https://github.com/ni/nimi-python/issues?q=is%3Aopen+is%3Aissue+label%3Aniscope\n\n\n.. |niscopeOpenPRs| image:: https://img.shields.io/github/issues-pr/ni/nimi-python/niscope.svg\n :alt: Pull Requests for NI-SCOPE\n :target: https://github.com/ni/nimi-python/pulls?q=is%3Aopen+is%3Aissue+label%3Aniscope\n\n\n\n.. _niscope_installation-section:\n\nInstallation\n------------\n\nAs a prerequisite to using the **niscope** module, you must install the NI-SCOPE runtime on your system. Visit `ni.com/downloads <http://www.ni.com/downloads/>`_ to download the driver runtime for your devices.\n\nThe nimi-python modules (i.e. for **NI-SCOPE**) can be installed with `pip <http://pypi.python.org/pypi/pip>`_::\n\n $ python -m pip install niscope~=1.4.8\n\n\nContributing\n============\n\nWe welcome contributions! You can clone the project repository, build it, and install it by `following these instructions <https://github.com/ni/nimi-python/blob/master/CONTRIBUTING.md>`_.\n\nUsage\n------\n\nThe 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.\n\n.. code-block:: python\n\n import niscope\n with niscope.Session(\"Dev1\") as session:\n session.channels[0].configure_vertical(range=1.0, coupling=niscope.VerticalCoupling.AC)\n session.channels[1].configure_vertical(range=10.0, coupling=niscope.VerticalCoupling.DC)\n session.configure_horizontal_timing(min_sample_rate=50000000, min_num_pts=1000, ref_position=50.0, num_records=5, enforce_realtime=True)\n with session.initiate():\n waveforms = session.channels[0,1].fetch(num_records=5)\n for wfm in waveforms:\n print('Channel {}, record {} samples acquired: {:,}\\n'.format(wfm.channel, wfm.record, len(wfm.samples)))\n\n # Find all channel 1 records (Note channel name is always a string even if integers used in channel[])\n chan1 = [wfm for wfm in waveforms if wfm.channel == '0']\n\n # Find all record number 3\n rec3 = [wfm for wfm in waveforms if wfm.record == 3]\n\nIf you need faster fetch performance, or to directly interface with `SciPy <https://www.scipy.org/>`_, you can use the **fetch_into()** method instead of **fetch()**. See the fetch_into example.\n\n\n`Other usage examples can be found on GitHub. <https://github.com/ni/nimi-python/tree/master/src/niscope/examples>`_\n\n\n.. _support-section:\n\nSupport / Feedback\n==================\n\nFor support specific to the Python API, follow the processs in `Bugs / Feature Requests`_.\nFor support with hardware, the driver runtime or any other questions not specific to the Python API, please visit `NI Community Forums <https://forums.ni.com/>`_.\n\n.. _bugs-section:\n\nBugs / Feature Requests\n=======================\n\nTo report a bug or submit a feature request specific to Python API, please use the\n`GitHub issues page <https://github.com/ni/nimi-python/issues>`_.\n\nFill in the issue template as completely as possible and we will respond as soon\nas we can.\n\n\n.. _documentation-section:\n\nDocumentation\n=============\n\nDocumentation is available `here <http://niscope.readthedocs.io>`_.\n\n\n.. _license-section:\n\nLicense\n=======\n\n**nimi-python** is licensed under an MIT-style license (`see\nLICENSE <https://github.com/ni/nimi-python/blob/master/LICENSE>`_).\nOther incorporated projects may be licensed under different licenses. All\nlicenses allow for non-commercial and commercial use.\n\n\n**gRPC Features**\n\nFor driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is\nsubject to the NI General Purpose EULA (`see NILICENSE <https://github.com/ni/nimi-python/blob/master/NILICENSE>`_).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI-SCOPE Python API",
"version": "1.4.8",
"project_urls": {
"Homepage": "https://github.com/ni/nimi-python"
},
"split_keywords": [
"niscope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "732dc580e050c9b4cdfadde324a515b09ed74eb62d42fe395b30b63453f2bfd0",
"md5": "707ecbfd4e3fe610fc8e309820ae7c1c",
"sha256": "43e35b0c2c636360e21c366dee6cff8d42bd34eeca185d4ad1b4a7819e742b90"
},
"downloads": -1,
"filename": "niscope-1.4.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "707ecbfd4e3fe610fc8e309820ae7c1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 102834,
"upload_time": "2024-04-26T20:12:13",
"upload_time_iso_8601": "2024-04-26T20:12:13.952671Z",
"url": "https://files.pythonhosted.org/packages/73/2d/c580e050c9b4cdfadde324a515b09ed74eb62d42fe395b30b63453f2bfd0/niscope-1.4.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dbf0ee1a328b7b0dbee5ef13164ae221e0761f4f822bf018b66182dbc0904d6",
"md5": "d12056a67741c500e86fb570ba64b7d3",
"sha256": "990df6e08dee77e4ea4e5a2e815ef08e30044c5b0688d9fbdcf9ce461ad4caa3"
},
"downloads": -1,
"filename": "niscope-1.4.8.tar.gz",
"has_sig": false,
"md5_digest": "d12056a67741c500e86fb570ba64b7d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 100372,
"upload_time": "2024-04-26T20:12:28",
"upload_time_iso_8601": "2024-04-26T20:12:28.907734Z",
"url": "https://files.pythonhosted.org/packages/8d/bf/0ee1a328b7b0dbee5ef13164ae221e0761f4f822bf018b66182dbc0904d6/niscope-1.4.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 20:12:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ni",
"github_project": "nimi-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "niscope"
}
JSON
