shepherd-herd 2026.2.1

Synchronized Energy Harvesting Emulator and Recorder CLI

Shepherd-Herd

Main Documentation: https://nes-lab.github.io/shepherd/tools/herd

Main Project: https://github.com/nes-lab/shepherd

Source Code: https://github.com/nes-lab/shepherd/tree/main/software/shepherd_herd

---

Shepherd-herd is the command line utility for controlling a group of shepherd observers remotely through an IP-based network. This is the key user interface for a private shepherd instance in the same network. The python package must be installed on the user's local machine and sends commands to the sheep via ssh.

Installation

shepherd-herd is a python package and available on PyPI. Use your python package manager to install it. For example, using pip:

pip3 install shepherd-herd

For install directly from GitHub-Sources (here dev-branch):

pip install git+https://github.com/nes-lab/shepherd.git@dev#subdirectory=software/shepherd-herd -U

For install from local sources:

cd shepherd/software/shepherd-herd/
pip3 install . -U

Usage

For details either use the help provided by the tool or have a look into the documentation

Usage with Windows is possible, but not recommended.
At least the unittests are flakey after 5+ tests and can result in zombie-threads crashing the program.

Library-Examples

See example-files for details.