.. MatFlow documentation master file, created by
   sphinx-quickstart on Wed Mar 16 10:54:48 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MatFlow's documentation!
===================================

MatFlow is an open source Python framework for managing computational materials science workflows.
It is designed to be flexible and extensible, allowing users to link together existing tools and anlaysis scripts into cohesive workflows, that can be deployed either locally or on powerful HPC systems.
These workflows are described in the form of simple YAML text files, which can be shared and reused to reproduce results.

It was originally developed by `Adam Plowman <https://lightform.org.uk/people/dr-adam-plowman>` and is actively supported by researchers at the University of Manchester's `CLARI (formerly LightForm) group <https://lightform.org.uk/>` and collaborators, and at UKAEA.
For an example of usage, see `Plowman et al. 2023 <https://doi.org/10.12688/materialsopenres.17516.1>`.

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

   Install <installation>
   User Guide <user/index>
   Reference <reference/index>
   Development <development/index>


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

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