shepherd-client 2025.10.1

Web-Client for the Shepherd-Testbed

Schepherd-Client

Shepherd Nova Testbed: https://testbed.nes-lab.org/

Testbed-WebAPI: https://shepherd.cfaed.tu-dresden.de:8000

Source Code: https://github.com/nes-lab/shepherd-webapi

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

---

The Testbed-Client links the user to the testbed. It's written in Python and uses http-requests to communicate with the web-API. As the source is open, you can modify and extend it as you like. You could also write your own tools based on these few hundred lines of code.

Features

• register & delete an account
• query user information
• create, schedule, query state of experiments
• download results

In the near future, the functionality will be extended to:

• list content like available energy environments, firmwares, virtual power sources (currently hardcoded in shepherd-core)
• query the testbed data-model (currently hardcoded in shepherd-core)
• query state of the observers (last seen alive)
• query statistics on the scheduler-queue
• CLI

Getting started

Install

You can install the client by using the package-manager of your choice. In the following example we show pip and uv:

pip3 install shepherd-client -U
# or modern uv with automatic virtual environment
uv pip install shepherd-client -U

Newest features can be obtained by directly installing from GitHub:

uv pip install git+https://github.com/nes-lab/shepherd-webapi.git@main#subdirectory=shepherd_client

Usage

The current interface is introduced in 5 short examples in the example-directory.