openSAMPL Documentation

Python tools for loading, storing, and visualizing clock data in PostgreSQL / TimescaleDB.

Overview

opensampl is an Oak Ridge National Laboratory (ORNL) project for synchronization analytics and monitoring data.

The package provides:

• a CLI for loading probe files and direct table data
• collection tooling for supported probe families
• optional Docker-backed server helpers
• Grafana dashboards and supporting backend components

OpenSAMPL currently supports probe families including ADVA, Microchip TWST, Microchip TP4100, and NTP.

Getting started

• Installation
• Quickstart

Guides

• Configuration
• Using the opensampl CLI
• Using the opensampl-server CLI
• Collection Guide
• Random Data Guide
• NTP Extension Guide

API references

• openSAMPL API Reference

Repository

git clone git@github.com:ORNL/OpenSAMPL.git