Welcome to SHEPHERD’s documentation

Introduction

• Overview
• Help

User Guide

• Basics
  • Time-synchronization
  • Harvester
  • Emulator
  • Remote programming/debugging
• Getting started
  • Prerequisites
  • Hardware setup
  • Installation - Images
  • Installation - Full Guide
  • Installation - ready-to-use image
• Hardware
  • Overview
  • The Cape
  • Harvesting Port
  • Harvesting Sources
  • Target Port
  • nRF-Target
• Calibration
  • References
• Data format
  • Usage Examples
  • Compression & Beaglebone
  • References
• Performance Specification
• Virtual Source
  • Harvester
  • Emulator
  • Sim-Example 1
  • Sim-Example 2
• Virtual Harvester
• Virtual Source OLD
  • Emulator OLD
  • Settings OLD
  • Recording OLD
  • Model OLD
• Experiment-Creation
  • YAML
  • Python

Public Testbed

• Instance at TU Dresden
  • Deployment
  • Controlling the Testbed
  • Example-Workflow
  • Related & Useful Links
  • Contributions
• Target Boards & Firmware
  • nRF52 with MSP430FR as FRAM
  • Getting started
• Web-Api

Tools

• Shepherd-Sheep
  • Command-Line Interface
  • Unittests
  • Reference
• Shepherd-Herd
  • Installation
  • Configuration
  • Command-Line Interface
  • Unittests
• Core Library
  • Features
  • Installation
• Shepherd-Data
  • Installation
  • Command-Line Interface
  • Unittests
• Cape-Calibration-Tool
  • Installation
  • Usage
  • Examples
• Time-Sync - Analyzer-Tool
  • Installation
  • Expected Data-Format
  • Run Analysis
  • Extras
• Webservice
  • FastApi Webservice (current prototype)
  • Cornerstones
  • install
  • run server
  • save state

APIs

• Shepherd-Herd
• Shepherd-Sheep
• Shepherd-Sheep - Advanced
• Shepherd-Data - HDF5 Reader & Writer
• Shepherd-Core - Config-Models
• Shepherd-Core - Virtual Source Sim
• Shepherd-Core - Waveform Decoder

Developer Guide

• Contributing
  • Codestyle
  • Development setup
  • Build the docs
  • Tests
  • Releasing
• Data handling
  • Data Acquisition
  • PRU to host
  • Database
• SYSFS interface
  • Basic Functionality
  • Virtual Source
  • PRU Programmer
  • References
• GPS-Time-Synchronisation
  • General Structure
  • Hardware setup
  • Configuring GNSS module
  • Deploy
  • Useful commands
  • Pitfalls
• PRU-Firmware
  • Debug via GPIO
  • Install CGT
  • Install GCC-Port
  • Differences CGT vs GCC
• Improvements of Shepherd v2
  • Overview
  • Features in Detail
• Time-Sync - Analysis
  • Setup
  • GPIO - Jitter
  • Sync Performance
  • Deeper Dive
• Time-Sync - Measurement
  • Prepare Software
  • Set up Hardware
  • Measurement
  • Analysis