Metadata-Version: 2.3
Name: nislsc
Version: 0.1.0
Summary: NI-SLSC Python API
License: MIT
Keywords: nislsc,slsc
Author: NI
Author-email: opensource@ni.com
Maintainer: Jun Ying Tan
Maintainer-email: jun.ying.tan@emerson.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Project-URL: Repository, https://github.com/ni/nislsc-python
Description-Content-Type: text/markdown

# nislsc-python

## About

The **nislsc** package allows you to develop instrumentation, acquisition, and control applications with NI Switch Load and Signal Conditioning (SLSC) devices in Python.
NI created and supports this package.

<!--
### Documentation

- TODO: Add documentation here.
-->

### Implementation

The package is implemented in Python as an object-oriented wrapper around the NI-SLSC C API using the [ctypes](https://docs.python.org/3/library/ctypes.html) Python Library.

### Supported NI-SLSC Driver Versions

This package requires the NI-SLSC C API, which was introduced in NI-SLSC 20.0.

### Operating System Support

**nislsc** supports Windows and Linux operating systems where the NI-SLSC 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

**nislsc** supports CPython 3.9+ and PyPy3.

## Installation

You can use [pip](http://pypi.python.org/pypi/pip>) to download **nislsc** from
[PyPI](https://pypi.org/project/nislsc/) and install it:

```bash
$ python -m pip install nislsc
```

<!--
## Getting Started

- TODO: Insert getting started documentation here.
-->

## Python Examples

You can find the examples for **NI-SLSC Python** in the [nislsc-python examples](https://github.com/ni/nislsc-python/tree/main/examples) directory. For best results, use the examples that correspond to your current **nislsc** version. For example, if you are using version 1.0.0, then check out the examples directory in the 1.0.0 tag. Newer examples may demonstrate features that are not available in previous versions of **nislsc**.

<!--
## Usage

- TODO: Insert usage instructions here.
-->

## Bugs / Feature Requests

To report a bug or submit a feature request, please use the [GitHub issues page](https://github.com/ni/nislsc-python/issues).

### Information to Include When Asking for Help

Please include **all** of the following information when opening an issue:

- Detailed steps on how to reproduce the problem and full traceback, if applicable.
- The Python version used:

    ```bash
    python -c "import sys; print(sys.version)"
    ```

- The version of the **nislsc** used:

    ```bash
    python -m pip list
    ```

- The version of the NI-SLSC driver used. Follow [this KB article](http://digital.ni.com/express.nsf/bycode/ex8amn) to determine the version of NI-SLSC you have installed.
- The operating system and version, for example Windows 11, Ubuntu 24.04, ...

## License

**nislsc** is licensed under an MIT-style license (see [LICENSE](https://github.com/ni/nislsc-python/blob/master/LICENSE)). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.

