Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.01 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.01 KB
Raw

NilsPodLib

PyPI codecov Test and Lint Documentation Status Code style: black PyPI - Downloads

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.8 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
cd nilspodlib
poetry install

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

CONFIGURED TASKS
  format         
  lint           Lint all files with Prospector.
  check          Check all potential format and linting issues.
  test           Run Pytest with coverage.
  docs           Build the html docs using Sphinx.
  bump_version

by calling

poetry run poe <command name>