NilsPodLib

A python package to parse logged NilsPod binary files.

Installation

pip install nilspodlib --upgrade

If you have access to the mad-lab gitlab server, you can further install the nilspodrefcal repository, which contains reference calibrations for a selected set of NilsPod sensors. You can install it using:

pip install git+https://mad-srv.informatik.uni-erlangen.de/MadLab/portabilestools/nilspodrefcal.git --upgrade

For users of NilsPodLib v1.0

With v2.0.0 the name of the library was updated from NilsPodLib to nilspodlib to comply with the recommended naming style for Python packages. Therefore, you need to update your import path when updating to the new version!

For developer

Install Python >=3.9 and uv. Then run the commands below to get the latest source and install the dependencies:

git clone https://github.com/mad-lab-fau/NilsPodLib.git
cd nilspodlib
uv sync --dev

To run any of the tools required for the development workflow, use the poe commands:

poe 

CONFIGURED TASKS
  format          Format all files with ruff.
  lint            Lint all files with ruff.
  check           Check all potential format and linting issues.
  test            Run Pytest with coverage.
  docs            Build the html docs using Sphinx.
  version         Bump version in all relevant places.

by calling

poe <command name>