Skip to main content

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

Support Policy

nitclk supports all the Operating Systems supported by NI-TClk.

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

NI-TClk Python API Status

NI-TClk (nitclk)

Driver Version Tested Against

2024 Q2

PyPI Version

Latest NI-TClk Version

Supported Python Version

NI-TClk supported Python versions

Documentation

NI-TClk Python API Documentation Status

Open Issues

Open Issues + Pull Requests for NI-TClk

Open Pull Requests

Pull Requests for NI-TClk

Installation

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

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

$ python -m pip install nitclk~=1.4.8

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 nitclk module

import nitclk

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

nitclk-1.4.8.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

nitclk-1.4.8-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file nitclk-1.4.8.tar.gz.

File metadata

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

File hashes

Hashes for nitclk-1.4.8.tar.gz
Algorithm Hash digest
SHA256 801c8eca37aa001274950e5198bc3184d22d2142f13d6ce4e46995ad9786aa18
MD5 10d37a6ea8ee1672424ff76e959a70fb
BLAKE2b-256 b9ccc69c2fa78d615ff5523a44c2cfe7df3896b3223589c93c70464c52fd7625

See more details on using hashes here.

File details

Details for the file nitclk-1.4.8-py3-none-any.whl.

File metadata

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

File hashes

Hashes for nitclk-1.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 028c7e996b4dbd1ab4459e1f1c2f4bbc65ac169714493bdd5bb9d30a7d4280a2
MD5 47d6d03e8499eb10c452e8c7eebee15e
BLAKE2b-256 1e4c13ce4d00f30033498c2957547b8847e08c2fd72686bd02d8f9f460afb8e6

See more details on using hashes here.

Supported by

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