.. apsbss documentation master file, created by
   sphinx-quickstart on Wed Nov 15 14:58:09 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

======
apsbss
======

Read-only interface to information from APS Proposal and ESAF (experiment safety
approval form) databases.

.. icons: https://fonts.google.com/icons

.. grid:: 2

    .. grid-item-card:: :material-regular:`install_desktop;3em` :ref:`Install <install>`

      Install the ``apsbss`` package and get started.

    .. grid-item-card:: :material-regular:`apps;3em` :ref:`apsbss_application`

      ``apsbss``, the command-line program.

    .. grid-item-card:: :material-regular:`precision_manufacturing;3em` :ref:`apsbss_ioc`

      (optional) The local EPICS IOC.

    .. grid-item-card:: :material-regular:`subscriptions;3em` :ref:`api`

      Source-code documentation.

.. toctree::
   :maxdepth: 1
   :hidden:

   install
   apsbss
   ioc
   api/index

   changes
   license

About
-----

:home: https://bcda-aps.github.io/apsbss
:source: https://github.com/bcda-aps/apsbss
:full version: |release|
:published: |today|
:revisions: :ref:`History of code changes <changes>`
:copyright: 2017-2025, UChicago Argonne, LLC
:license: :ref:`ANL OPEN SOURCE LICENSE <license>` (see LICENSE.txt file)
:author: Pete R. Jemian <jemian@anl.gov>
:index: :ref:`genindex`

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