.. _api.demo_instrument:

Demo Instrument
===============

.. currentmodule:: apsbits.demo_instrument

.. autosummary::
   :toctree: generated
   :recursive:

   startup
   callbacks
   devices
   plans

Example Usage
-------------

.. code-block:: py

    from apsbits.demo_instrument.startup import *

Components
----------

The demo instrument is organized into several components:

callbacks
~~~~~~~~~

.. autosummary::
   :toctree: generated
   :recursive:

   callbacks.nexus_data_file_writer
   callbacks.spec_data_file_writer

devices
~~~~~~~

.. autosummary::
   :toctree: generated
   :recursive:


plans
~~~~~

.. autosummary::
   :toctree: generated
   :recursive:

   plans.dm_plans
   plans.sim_plans