sisock - SImons observatory data over webSOCKets

sisock is a python library and collection of components for serving quicklook data over websockets, designed initially for the Simons Observatory. The goal is to define an API for implementing a DataNodeServer, which returns the desired data, whether from memory or from disk. Data is passed through a crossbar server using the WebSockets protocol.

sisock plays a key role in the Simons Observatory housekeeping live monitor, which is based on the open source analytics and monitoring platform Grafana. A simple webserver sits between sisock and Grafana, allowing Grafana to query the sisock DataNodeServers.

User’s Guide

Start here for information about the design and use of sisock.

• Live Monitoring Setup Guide
  • Dependencies
  • Software Installation
  • Environment Setup
  • Configuration
  • Running Docker
  • Running OCS Clients
  • Using Grafana
  • Other Info
• Components
  • sisock-crossbar
  • sisock-http
  • g3-file-scanner
  • Common Configuration
• DataNodeServers
  • example-weather
  • example-sensors
  • apex-weather
  • data-feed
  • ucsc-radiometer
  • g3-reader

Developer’s Guide

If you are interested in the details of how individual components work, look here.

• g3 File Scanner
  • Overview
  • SQL Database Design

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • sisock.base module

Indices and tables

• Index
• Module Index
• Search Page