| Name | nisync JSON |
| Version |
0.1
JSON |
| download |
| home_page | https://github.com/ni/nisync-python |
| Summary | NI-Sync Python API |
| upload_time | 2024-09-23 01:32:56 |
| maintainer | NI |
| docs_url | None |
| author | NI |
| requires_python | <4.0.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
| **Info** | Contains a Python API for interacting with NI-Sync. See [GitHub](https://github.com/ni/nisync-python/) for the latest source. |
| :------------ | :---------------------|
| **Author** | National Instruments |
# Table of Contents
- [About](#about)
- [Documentation](#documentation)
- [Implementation](#implementation)
- [Supported NI-Sync Driver Versions](#supported-ni-sync-driver-versions)
- [Operating System Support](#operating-system-support)
- [Python Version Support](#python-version-support)
- [Installation](#installation)
- [Manual Driver Installation](#manual-driver-installation)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Python Examples](#python-examples)
- [License](#license)
# About
The **nisync** package allows you to develop timing and synchronization applications
for both time-based and signal-based synchronizations with NI-Sync devices in Python.
## Documentation
Refer to the [NI-Sync User Manual](https://www.ni.com/docs/en-US/bundle/ni-sync/page/user-manual-welcome.html)
for API-agnostic information about NI-Sync concepts.
## Implementation
The package is implemented in Python as an
object-oriented wrapper around the NI-Sync C API using the
[ctypes](https://docs.python.org/3/library/ctypes.html) Python library.
## Supported NI-Sync Driver Versions
**nisync** supports all versions of NI-Sync. Some functions in the **nisync**
package may be unavailable with earlier versions of NI-Sync driver. Refer to
the [Installation](#installation) section for details on how to install the latest version
of the NI-Sync driver.
## Operating System Support
**nisync** supports Windows and Linux operating systems where the NI-Sync
driver is supported. Refer to
[NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support)
for which versions of the driver support your hardware on a given operating
system.
## Python Version Support
**nisync** supports CPython 3.8+ and PyPy3.
# Installation
Running **nisync** requires NI-Sync to be installed.
**nisync** can be installed with [pip](http://pypi.python.org/pypi/pip>):
```shell
python -m pip install nisync
```
## Manual Driver Installation
Visit [ni.com/downloads](http://www.ni.com/downloads/) to download the latest
version of NI-Sync. None of the recommended **Additional items** are required
for **nisync** to function, and they can be removed to minimize installation
size. It is recommended you continue to install the **NI Certificates** package
to allow your Operating System to trust NI built binaries, improving your
software and hardware installation experience.
# Getting Started
In order to use the **nisync** package, you must have at least one device that supports NI-Sync
installed on your system. Both physical and simulated devices are supported.
You can use **NI MAX** or **NI Hardware Configuration Utility** to verify and configure your devices.
Finding and configuring device name in **NI MAX**:
Finding and configuring device name in **NI Hardware Configuration Utility**:
# Usage
The following is a basic example of using an **nisync.nisync.Session** object. This example illustrates how to connect and disconnect clock terminals to synchronize devices using the onboard oscillator as the clock source. This is particularly useful in applications requiring precise timing and synchronization across multiple devices.
## Python Examples
```python
import nisync
from nisync.constants import PXI_CLK10_IN, OSCILLATOR
# Create a new session with the nisync library
with nisync.Session(resource_name="PXI1Slot10") as session:
# Connect the onboard oscillator to the PXI_CLK10_IN terminal
# This setup is typically used for synchronizing measurements across devices
session.connect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
# Perform measurements or operations that require synchronization
# Once operations are complete, disconnect the terminals
session.disconnect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)
```
# License
**nisync** is licensed under an MIT-style license (see
[LICENSE](https://github.com/ni/nisync-python/blob/main/LICENSE)).
Other incorporated projects may be licensed under different licenses. All
licenses allow for non-commercial and commercial use.
Raw data
{
"_id": null,
"home_page": "https://github.com/ni/nisync-python",
"name": "nisync",
"maintainer": "NI",
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": "opensource@ni.com",
"keywords": null,
"author": "NI",
"author_email": "opensource@ni.com",
"download_url": "https://files.pythonhosted.org/packages/5f/67/9cf02ee414b9ba8dad9eea4d027b080f5db26959586fce2cc374ba8edc6b/nisync-0.1.tar.gz",
"platform": null,
"description": "| **Info** | Contains a Python API for interacting with NI-Sync. See [GitHub](https://github.com/ni/nisync-python/) for the latest source. | \n| :------------ | :---------------------| \n| **Author** | National Instruments | \n\n# Table of Contents\n- [About](#about)\n - [Documentation](#documentation)\n - [Implementation](#implementation)\n - [Supported NI-Sync Driver Versions](#supported-ni-sync-driver-versions)\n - [Operating System Support](#operating-system-support)\n - [Python Version Support](#python-version-support)\n- [Installation](#installation)\n - [Manual Driver Installation](#manual-driver-installation)\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n - [Python Examples](#python-examples)\n- [License](#license)\n\n# About\n\nThe **nisync** package allows you to develop timing and synchronization applications \nfor both time-based and signal-based synchronizations with NI-Sync devices in Python.\n\n## Documentation\n\nRefer to the [NI-Sync User Manual](https://www.ni.com/docs/en-US/bundle/ni-sync/page/user-manual-welcome.html)\nfor API-agnostic information about NI-Sync concepts.\n\n## Implementation\n\nThe package is implemented in Python as an \nobject-oriented wrapper around the NI-Sync C API using the\n[ctypes](https://docs.python.org/3/library/ctypes.html) Python library.\n\n## Supported NI-Sync Driver Versions\n\n**nisync** supports all versions of NI-Sync. Some functions in the **nisync** \npackage may be unavailable with earlier versions of NI-Sync driver. Refer to \nthe [Installation](#installation) section for details on how to install the latest version \nof the NI-Sync driver.\n\n## Operating System Support\n\n**nisync** supports Windows and Linux operating systems where the NI-Sync\ndriver is supported. Refer to\n[NI Hardware and Operating System Compatibility](https://www.ni.com/r/hw-support)\nfor which versions of the driver support your hardware on a given operating\nsystem.\n\n## Python Version Support\n\n**nisync** supports CPython 3.8+ and PyPy3.\n\n# Installation\n \nRunning **nisync** requires NI-Sync to be installed.\n**nisync** can be installed with [pip](http://pypi.python.org/pypi/pip>):\n\n```shell\npython -m pip install nisync\n```\n\n## Manual Driver Installation\n\nVisit [ni.com/downloads](http://www.ni.com/downloads/) to download the latest\nversion of NI-Sync. None of the recommended **Additional items** are required\nfor **nisync** to function, and they can be removed to minimize installation\nsize. It is recommended you continue to install the **NI Certificates** package\nto allow your Operating System to trust NI built binaries, improving your\nsoftware and hardware installation experience.\n\n# Getting Started\n\nIn order to use the **nisync** package, you must have at least one device that supports NI-Sync \ninstalled on your system. Both physical and simulated devices are supported.\nYou can use **NI MAX** or **NI Hardware Configuration Utility** to verify and configure your devices.\n\nFinding and configuring device name in **NI MAX**:\n\n\nFinding and configuring device name in **NI Hardware Configuration Utility**:\n\n\n\n# Usage\nThe following is a basic example of using an **nisync.nisync.Session** object. This example illustrates how to connect and disconnect clock terminals to synchronize devices using the onboard oscillator as the clock source. This is particularly useful in applications requiring precise timing and synchronization across multiple devices.\n\n## Python Examples\n\n```python\nimport nisync\nfrom nisync.constants import PXI_CLK10_IN, OSCILLATOR\n\n# Create a new session with the nisync library\nwith nisync.Session(resource_name=\"PXI1Slot10\") as session:\n # Connect the onboard oscillator to the PXI_CLK10_IN terminal\n # This setup is typically used for synchronizing measurements across devices\n session.connect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)\n \n # Perform measurements or operations that require synchronization\n \n # Once operations are complete, disconnect the terminals\n session.disconnect_clock_terminals(OSCILLATOR, PXI_CLK10_IN)\n```\n\n# License\n\n**nisync** is licensed under an MIT-style license (see\n[LICENSE](https://github.com/ni/nisync-python/blob/main/LICENSE)).\nOther incorporated projects may be licensed under different licenses. All\nlicenses allow for non-commercial and commercial use.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NI-Sync Python API",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/ni/nisync-python",
"Repository": "https://github.com/ni/nisync-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99fd9a87b4d2d7351269aab5a98e27c724887491e1846484243bf71dd6db24cd",
"md5": "587328714a5ef9531ff4163795d0cd06",
"sha256": "24ce83b989988211473e27e3a9060d13d20b70d27049710b93ddf23542934c31"
},
"downloads": -1,
"filename": "nisync-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "587328714a5ef9531ff4163795d0cd06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 26198,
"upload_time": "2024-09-23T01:32:54",
"upload_time_iso_8601": "2024-09-23T01:32:54.736303Z",
"url": "https://files.pythonhosted.org/packages/99/fd/9a87b4d2d7351269aab5a98e27c724887491e1846484243bf71dd6db24cd/nisync-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f679cf02ee414b9ba8dad9eea4d027b080f5db26959586fce2cc374ba8edc6b",
"md5": "9d7345df240b8b4bcce37f6eb51dd844",
"sha256": "3768dffc1c549863bcf087eda105f2ba4de4ca9e3511d88a6ba1f69c845c541d"
},
"downloads": -1,
"filename": "nisync-0.1.tar.gz",
"has_sig": false,
"md5_digest": "9d7345df240b8b4bcce37f6eb51dd844",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 24555,
"upload_time": "2024-09-23T01:32:56",
"upload_time_iso_8601": "2024-09-23T01:32:56.748652Z",
"url": "https://files.pythonhosted.org/packages/5f/67/9cf02ee414b9ba8dad9eea4d027b080f5db26959586fce2cc374ba8edc6b/nisync-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 01:32:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ni",
"github_project": "nisync-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nisync"
}
