NDI-python

A Python port of VH-Lab/NDI-matlab.

Installation

To install the package, run the following command in the root directory. Note the dot . at the end, which tells pip to install from the current directory. This will automatically install all required dependencies (including did, ndi-compress, etc.):

pip install .

If you are installing for development (editable mode), use the -e flag (again, note the dot . at the end):

pip install -e .

Usage

import ndi

Development

Environment Setup

To set up the development environment, first create and activate a virtual environment:

python3 -m venv venv
source venv/bin/activate

Dependency Installation

Install the package in editable mode, which will also install all dependencies:

pip install -e .

Running Tests

To run the tests, use the following command:

python -m unittest discover -s tests -t .

Building Documentation

To build the documentation, use the following command:

mkdocs build