.. Topaz3 documentation master file, created by
   sphinx-quickstart on Fri Jul 19 15:41:43 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Topaz3 documentation!
==================================

**Topaz3** is a tool for data transformation and machine learning, developed at `Diamond Light Source <https://www.diamond.ac.uk/>`_.

The code can be found in this repository: `<https://github.com/DiamondLightSource/python-topaz3/>`_

The documentation here is designed to provide clearer explanations of how the module provided work,
so that they can be adapted to different situations.

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

   installation
   preparation
   training
   predictions
   functions
   shell_scripts


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

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