.. magnet documentation master file, created by
   sphinx-quickstart on Fri May 24 15:28:19 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================
Magnet documentation
====================

``Magnet`` (**M**\ esh **A**\ lomeration by **G**\ raph neural **NET**\ work) is a python package for mesh agglomeration.
The package includes state of the art methods, like Metis and k-means, as well as pre-trained deep learning models and a complete toolchain to build, train and test graph neural networks.


Contents
========

.. toctree::
    :maxdepth: 2

    User guides <tutorials>

.. toctree::
    :maxdepth: 2

    Reference manual <manual>

.. toctree::
    :maxdepth: 2

    Lymph interface <lymph_interface/lymph>

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

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