.. FabNEPTUNE documentation master file, created by
   sphinx-quickstart on Fri Mar 19 10:32:30 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to FabNEPTUNE's documentation!
=================================

FabNEPTUNE is a `FabSim3 <https://github.com/djgroen/FabSim3>`_ plugin for automated ``NEPTUNE(UKAEA’s fusion project in the UK)``-based simulations.

This plugin provides functionality to extend FabSim3’s workflow and local/remote submission capabilities to NEPTUNE specific tasks.

.. toctree::
   :caption: Installation and build
   :maxdepth: 1

   installation

.. toctree::
   :caption: FabNEPTUNE Workflow 
   :maxdepth: 1

   workflow

.. toctree::
   :caption: Execution
   :maxdepth: 1

   execution