Shepherd-Data

PyPiVersion image Pytest CodeStyle

Documentation: https://orgua.github.io/shepherd/external/shepherd_data.html

Source Code: https://github.com/orgua/shepherd-datalib

Main Project: https://github.com/orgua/shepherd

This Python Module eases the handling of hdf5-recordings used by the shepherd-testbed. Users can read, validate and create files and also extract, down-sample and plot information.

Installation

PIP - Online

pip3 install shepherd-data -U

For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here dev-branch):

pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_data -U

Command-Line Interface

Note

The tool has integrated help-functionality. For a full list of supported commands and options, run shepherd-data --help and for more detail for each command shepherd-data [COMMAND] --help.

The command-line Interface is as follows:

Unittests

To run the testbench, follow these steps:

  1. Navigate your host-shell into the package-folder and

  2. install dependencies

  3. run the testbench (~ 30 tests):

cd shepherd-datalib/shepherd-data
pip3 install .[tests]
pytest