.. OptiBeam documentation master file, created by
   sphinx-quickstart on Mon Apr  1 10:18:41 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: /_static/images/logo.jpg
    :alt: OptiBeam
    :width: 150px
    :target: https://github.com/Andrew-XQY/OptiBeam
    :align: center


Welcome to OptiBeam's documentation!
====================================

OptiBeam is a Python package provides modules for processing images, analyzing data, visualizing results, and machine learning in Accelerator Physics.


Modules
-------

.. toctree::
   :titlesonly: 
   
   /modules/modules
   




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

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