Simons Observatory Control System
=================================

The Simons Observatory Control System (SOCS) repository contains SO specific
OCS code. This includes OCS Agents designed for interfacing with SO specific
hardware, as well as SO specific configuration recommendations. For information
about general OCS components, see the `OCS Documentation
<https://ocs.readthedocs.io/en/latest/?badge=latest>`_.

Contents
========

===================  ============================================================
Section              Description
===================  ============================================================
User Guide           Start here for information about the design and use of SOCS.
Agent Reference      Details on configuration and use of the OCS Agents
                     provided by SOCS.
Simulator Reference  Simulators are used to mock software and hardware
                     interfaces when access to actual hardware is unavailable.
                     These are useful for testing other code.
Developer Guide      Information relevant to developers who are contributing to
                     SOCS.
API Reference        Full API documentation for core parts of the SOCS library.
===================  ============================================================

.. toctree::
    :caption: User Guide
    :maxdepth: 2

    user/intro
    user/installation
    user/webserver
    user/sequencer

.. toctree::
    :caption: Agent Reference
    :maxdepth: 2

    agents/acu_agent
    agents/bluefors_agent
    agents/cryomech_cpa
    agents/devantech_dS378
    agents/fts_agent
    agents/fls
    agents/generator
    agents/galil_axis
    agents/hi6200
    agents/http_camera
    agents/hwp_encoder
    agents/hwp_gripper
    agents/hwp_pcu
    agents/hwp_picoscope
    agents/hwp_pid
    agents/hwp_pmx
    agents/hwp_supervisor_agent
    agents/holo_fpga
    agents/holo_synth
    agents/ibootbar
    agents/ifm_sbn246_flowmeter
    agents/kikusui_pcr500ma
    agents/labjack
    agents/lakeshore240
    agents/lakeshore336
    agents/lakeshore370
    agents/lakeshore372
    agents/lakeshore425
    agents/latrt_xy_stage
    agents/ld_monitor
    agents/magpie
    agents/meinberg_m1000_agent
    agents/meinberg_syncbox_agent
    agents/orientalmotor_blh
    agents/pfeiffer
    agents/pfeiffer_tc400
    agents/pysmurf-controller
    agents/pysmurf-monitor
    agents/rtsp_camera
    agents/scpi_psu
    agents/smurf_crate_monitor
    agents/smurf_timing_card
    agents/srs_cg635
    agents/stimulator_encoder
    agents/stimulator_thermometer
    agents/suprsync
    agents/synacc
    agents/tektronix3021c
    agents/thorlabs_mc2000b
    agents/ucsc_radiometer
    agents/ups
    agents/vantage_pro2
    agents/wiregrid_actuator
    agents/wiregrid_encoder
    agents/wiregrid_kikusui
    agents/wiregrid_tiltsensor

.. toctree::
    :caption: Simulator Reference
    :maxdepth: 2

    simulators/ls240_simulator
    simulators/ls372_simulator
    agents/smurf_file_emulator
    simulators/smurf_stream_simulator

.. toctree::
    :caption: Developer Guide
    :maxdepth: 2

    developer/interfaces/snmp
    developer/interfaces/tcp
    developer/testing

.. toctree::
    :caption: API Reference
    :maxdepth: 2

    api

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`