.. smug documentation master file, created by
   sphinx-quickstart on Fri Jul 29 14:50:13 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to smug's documentation!
================================

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

   auto_examples/index
   limber-api
   radynversion-api
   shaun-api

Introduction
------------

SMUG is intended to be a simple, easy to install and use, repository for the University of Glasgow solar deep learning models.
Namely, RADYNVERSION_, Limber, and Shaun_.
SMUG provides easy access to the pretrained models, which will be automatically downloaded when requested, as well as adapter classes to simplify their use.

.. _RADYNVERSION: https://github.com/Goobley/Radynversion
.. _Shaun: https://github.com/bionictoucan/shaun

Please see the example gallery and the tests in the repository for an illustration of how to apply these models.

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

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