Observatory Control System

The Observatory Control System is a distributed control system designed to coordinate data acquisition in astronomical observatories.

This documentation is split into three main sections. First, the User Guide. This is for users who want to configure and run a system controlled by OCS. Next, the Agent Reference. This section covers each OCS Agent and how to configure them. Finally, the Developer Guide. These pages are for those who want to understand more of what goes on within OCS, and for those looking to write OCS Agents or Clients.

User Guide

• Introduction
  • Architecture Overview
    • Agents and Control Clients
    • Docker
• Dependencies
  • Software Requirements
    • Python Dependencies
    • Other Dependencies
    • Operating System
  • Hardware Requirements
  • Networking Requirements
• Installation
  • Installing Docker
  • Installing Docker Compose
  • Installing OCS
    • Creating the OCS User
• Quickstart
  • Configuration Files
  • Running
  • Commanding
  • Viewing
  • Next Steps
  • Shutdown
• System Configuration
  • OCS Site Configuration
    • Overview
    • OCS Site Config File
    • Commandline Arguments
  • Docker Configuration
    • docker-compose.yaml
    • Considerations for Deployment
  • Crossbar Configuration
    • Overview
    • Running with Docker
  • Centralized Management
    • Overview
    • Configuration of HostManager Agents
    • Communicating with HostManager Agents
    • systemd Control of HostManagers
    • Using ocs-web with HostManager
• Network Configuration
  • Single-Node Configuration
    • Single-Configuration File
    • Multiple-Configuration Files
  • Multi-Node Configuration
• Log Aggregation
  • Installing Loki
  • Configuration
• ocs-web
• CLI Tools
  • ocsbow
    • Command-line arguments
  • ocs-local-support
    • Positional Arguments
    • Named Arguments
  • checkdata
    • Usage/Examples
  • datestring2ctime
  • g32influx
  • ocs-client-cli
    • Positional Arguments
    • Sub-commands
  • ocs-install-systemd
    • Options specific to systemd service creation
  • ocs-agent-cli
    • Named Arguments

Agent Reference

• Aggregator Agent
  • Agent Options
  • Dependencies
  • Configuration File Examples
    • OCS Site Config
    • Docker Compose
  • Description
    • File Format and Usage
    • HK File Structure
  • Agent API
    • AggregatorAgent
  • Supporting APIs
• Barebones Agent
  • Configuration File Examples
    • OCS Site Config
    • Docker Compose
  • Agent API
    • BarebonesAgent
• InfluxDB Publisher Agent
  • Agent Options
  • Configuration File Examples
    • OCS Site Config
    • Docker Compose
    • Grafana
  • Agent API
    • InfluxDBAgent
  • Supporting APIs
    • Publisher
• Registry Agent
  • Agent Options
  • Configuration File Examples
    • OCS Site Config
    • Docker Compose
  • Description
    • Operation Monitor
  • Agent API
    • Registry
  • Supporting APIs
    • RegisteredAgent
• Fake Data Agent
  • Agent Options
  • Configuration File Examples
    • OCS Site Config
    • Docker Compose
  • Agent API
    • FakeDataAgent
• HostManager Agent
  • Agent Options
  • Configuration File Examples
    • OCS Site Config
  • Description
  • Agent API
    • HostManager
  • Supporting APIs
    • HostManager._reload_config()

Developer Guide

• Architecture of the OCS
  • Base layer: WAMP and crossbar
  • Agent Operations: Tasks and Processes
  • Python Dependencies
    • crossbar.io
    • twisted and autobahn
• OCS Site Configuration
  • Overview
  • ocs.site_config
    • SiteConfig
    • HostConfig
    • InstanceConfig
  • Agent Site-related Command Line Parameters
    • Site Config Options
  • Control Clients and the Site Config
  • Agent Script Discovery
• Agents
  • Writing an Agent
    • Minimum Agent Structure
    • Adding a Task
    • Adding a Process
    • Implement Logging
    • Operation Locking
    • Using OCS Feeds
    • Adding Agent Arguments
    • Dockerizing an Agent
    • Building Images Automatically
    • Next Steps
  • Operation Parameters
    • Validation using @param
    • Validation in the Op function
  • TimeoutLock
    • Overview
    • Examples
  • Logging
  • Documentation
    • Task and Process Documentation
    • Agent Reference Pages
• Clients and Control Programs
  • OCSClient
    • Basic Usage
    • Passing Arguments to an Operation
    • Replies from Operation methods
    • Examples
  • Alternative Clients/Programs
    • ocs-web control panels
    • Control Programs using Twisted
• Data Access
  • Data Feeds
    • Registering Feeds
    • Publishing to a Feed
    • Subscribing to a Feed
  • session.data
    • Agent Access
    • Structure and Content
    • Client Access
• Writing Plugins
  • Plugin File
  • Package Entry Point
  • Agent Entry Point
  • Testing
  • Deploying + Docker
  • List of OCS Plugins
• Docker
  • OCS Base Image
  • Building Upon the Base Image
  • Using An OCS Image
• Testing
  • Running Tests
  • Test Organization
  • Unit Tests
  • Integration Tests
    • Reducing Turnaround Time in Testing
  • Code Coverage
  • Testing API
    • create_agent_runner_fixture()
    • create_client_fixture()
    • check_crossbar_connection()

API Reference

• API
  • agents
  • ocs.agent_cli
  • ocs.base
  • ocs.client_http
  • ocs.client_t
  • ocs.matched_client
  • ocs.ocs_agent
  • ocs.ocs_client
  • ocs.ocs_feed
  • ocs.ocs_twisted
  • ocs.site_config

Indices and tables

• Index

• Module Index

• Search Page