HISPEC Documentation

HISPEC is a high-resolution near-infrared spectrograph for Keck Observatory. This documentation site collects the instrument-control software notes, build procedures, deployment references, and operational information needed by the engineering team.

Getting Started

If you are new to the software, start with the architecture overview to understand how the system fits together, then use the daemon inventory to find the piece you care about.

If you are running the instrument, running the daemons with systemd covers starting, stopping, watching and debugging them.

If you are setting up a machine, Installing HISPEC on a host is the one way to put the software on it. The build notes cover the OS, packages and hardware for each host.

Architecture

• Software Architecture
  • Architecture Overview
  • Daemon, Driver and Config Inventory
  • Command and Control
  • Architecture Evolution
  • Conformance and Roadmap

Operations

• Installing HISPEC on a host
• Running the HISPEC Daemons with systemd

Build Notes

• Host Machine Build Setup
• FEI Server and RTC Build

Planned Documentation Areas

These sections are placeholders for the next round of documentation pages:

• developer setup and contribution workflow

• hardware interface notes per subsystem