Welcome to OCD’s documentation!

The Observation Condition Decision tool (OCD) monitors the Telescope Control System (TCS) and uses some of the information to decide the next observation.

This documentation is also available on hetdex-ocd.readthedocs.io.

Installation and usage

• Installation
  • Instructions
  • Dependances
  • Development
• Run OCD
  • ocd run
  • ocd config
  • ocd run_shot
  • ocd allow_hetdex
  • ocd db_replay
  • ocd docker_mysql
• Input files
  • Master configuration file
  • Shot file, input
  • Autoschedule
  • Logging configuration file
  • Shuffle configuration files
• Output files
  • Shot file, output
• Notes
  • ZeroMQ-based communication
  • MySQL database
  • Mock times
• How OCD works
  • OCD start
  • An event comes in
  • The MetaState
  • The shot runner
  • When a shot runs …
  • … and finishes

Contributions and development

• Contribute to ocd
  • How To
  • Coding style
  • Testing
  • Documentation

Code documentation

• ocd.allow_hetdex – The ocd allow_hetdex command
• ocd.auto_schedule – Schedule and execute the next shot(s)
• ocd.config – Configuration functionalities
• ocd.db_replay – Replay a database
• ocd.docker_mysql – The ocd mysql command
• ocd.errors – OCD error definitions
• ocd.heart_beat – Control the OCD main loop status and wait for connections
• ocd.main – ocd entrypoint and ocd run command
• ocd.orchestrator – Orchestrate OCD
• ocd.run_shot – Run a HETDEX shot
• ocd.shots_db – Store and manage shots
• ocd.states – OCD state machines
  • TCS events
  • Variables
  • BaseState – The state machines API
  • RunShotState – Keep track of the shots run by OCD
  • MetrologyState – Monitor the metrology
  • HetdexAllowedState – It is time to run HETDEX?
  • MetaState – Meta state machine
  • Mixin classes and helpers
  • Inheritance scheme
• ocd.storage – Storage classes
  • Inheritance scheme
• ocd.utils – Miscellaneous utilities

About

• LICENSE
• Authors
• OCD release notes
• Changelog
• TODO

Copyright notice

Copyright (c) 2018 “The HETDEX collaboration”.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled Documentation Licence: FDL v1.3.

Indices and tables

• Index
• Module Index
• Search Page