ATSpectrograph Developer Guide

[This section should provide an introduction of the system to the developer and an brief overview of the CSC architecture. This should include links to background information where appropriate.]

Dependencies

[This section should list dependencies in bullet form]

• SAL - v4.0.0

• ts_salobj - v5.2.0

ATSpectrograph API

The content in this section is autogenerated from docstrings.

lsst.ts.atspectrograph Package

Classes

CSC([config_dir, initial_state, simulation_mode])	Configurable Commandable SAL Component (CSC) for the Auxiliary Telescope Spectrograph.
MockSpectrographController(port)	Mock Spectrograph Controller that talks over TCP/IP.
Model(log)	ATSpectrogropah Model Class.

Build and Test

[This section is to walk a developer through the steps to build and test the software.]

Usage

[Description on how to use ths software, scripts, any useful programs etc. Basic operations such as startup/shutdown should be explained, ideally with example code/steps]

Simulator

[Information regarding the simulator, including how to run, restrictions, differences from real operation etc should be described here]

Updating Firmware of the ATSpectrograph

[This section should discuss the firmware currently installed and how to update it when required. Linking to firmware location is expected, along with details on any support equipment to write to FPGAs etc]

Building the Documentation

[This section is to walk the developer through building the documentation. This should be a step-by-step process as it will most likely be used by non-developers as well who wish to edit the docs]

Contributing

Code and documentation contributions utilize pull-requests on github. Feature requests can be made by filing a Jira ticket with the ATSpectrograph label. In all cases, reaching out to the contacts for this CSC is recommended.