.. Xi-cam documentation master file, created by
   sphinx-quickstart on Thu Jun  6 11:09:24 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. figure:: _static/animated_logo.gif
  :alt: Xi-CAM Documentation

Xi-CAM Documentation
====================

The :code:`Xi-CAM` package is a plugin-based framework and graphical user
interface (GUI) application for synchrotron data management, acquisition,
visualization, and analysis. Support for a variety of techniques is provided
through its plugin architecture.


Getting Started
---------------

Before starting to develop plugins, you will need to install Xi-CAM and some
of its dependencies.

Follow the QuickStart_ guide to get started with installation and
exploring an example Xi-CAM plugin (covers GUIPlugin, Workflow, and OperationPlugins).

For more detailed documentation, you may want to visit the following:

* GUIPlugin_ documentation
* OperationPlugin_ documentation
* Workflow_ documentation

The Resources_ section has useful links to tutorials, examples, and documentation
that can help with developing Xi-CAM plugins.


Developer Documentation
-----------------------

.. toctree::
   :maxdepth: 1

   quickstart
   install-linux
   install-macos
   install-windows
   gui-plugin
   entry-points
   operation-plugin
   workflow
   ingestors
   resources


Links
-----
* Xi-CAM GitHub_ Organization

.. _GitHub: https://github.com/Xi-CAM
.. _GUIPlugin: gui-plugin.html
.. _OperationPlugin: operation-plugin.html
.. _QuickStart: quickstart.html
.. _Resources: resources.html
.. _Workflow: workflow.html


Indices and tables
------------------

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