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¶
git clone https://github.com/mad-lab-fau/NilsPodLib.git
cd nilspodlib
poetry install
Install Python >3.7 and poetry. Then run the commands below to get the latest source and install the dependencies:
git clone https://github.com/mad-lab-fau/NilsPodLib.git
poetry install
To run any of the tools required for the development workflow, use the doit commands:
$ poetry run doit list
docs Build the html docs using Sphinx.
format Reformat all files using black.
format_check Check, but not change, formatting using black.
lint Lint all files with Prospector.
test Run Pytest with coverage.