.. Minim documentation master file, created by
   sphinx-quickstart on Mon Apr 19 08:39:15 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Minim
=====

Minim is a C++ library for energy minimisation problems.
It contains a variety of algorithms, such as gradient descent, L-BFGS, FIRE
and simulated annealing, and a selection of system potentials.
These can utilise MPI parallelisation using built-in frameworks.

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

   quickstart
   parallelisation
   algorithms/index
   potentials/index
   core_api
   communication_api
   utils_api