Metadata-Version: 2.4
Name: openlifu-sdk
Version: 1.0.4
Summary: Openwater LIFU SDK — hardware I/O interface library
Author-email: George Vigelette <george@openwater.health>
License-Expression: MIT
Project-URL: Homepage, https://github.com/OpenwaterHealth/openlifu-sdk
Project-URL: Bug Tracker, https://github.com/OpenwaterHealth/openlifu-sdk/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: pyserial
Requires-Dist: pyusb
Requires-Dist: base58
Provides-Extra: test
Requires-Dist: pytest>=6; extra == "test"
Requires-Dist: pytest-cov>=3; extra == "test"
Requires-Dist: pytest-mock; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest>=6; extra == "dev"
Requires-Dist: pytest-cov>=3; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Dynamic: license-file

# openlifu-sdk

Openwater LIFU SDK — standalone hardware I/O interface library.

This package provides the low-level communication layer for Openwater LIFU devices,
including the TX module and HV controller.

## Installation

```bash
pip install openlifu-sdk
```

Or for development:

```bash
pip install -e ".[dev]"
```

## Building a wheel

```bash
pip install build
python -m build
```

## Usage

```python
from openlifu_sdk import LIFUInterface

interface = LIFUInterface()
tx_connected, hv_connected = interface.is_device_connected()
```

## Examples

See the `examples/` directory for usage scripts.

Documentation
-------------

Detailed SDK documentation is available in the `docs/` folder. Start with [docs/README.md](docs/README.md) for installation, usage examples, and an API reference.
