.. Scotty documentation master file, created by
   sphinx-quickstart on Mon Oct 24 15:44:17 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Scotty's documentation!
==================================

The main interface to Scotty is through `beam_me_up()
<scotty.beam_me_up.beam_me_up>`. Many standard cases are provided
through `get_parameters_for_Scotty()
<scotty.get_parameters_for_Scotty>`.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   input
   output
   references
   api/modules


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

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