.. Mango documentation master file, created by
   sphinx-quickstart on Fri Jul  8 17:19:19 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Mango's documentation!
=================================

Mango is a molecular dynamics simulator of magnetic nanoparticles written primarily in `Python <https://www.python.org/>`_. It is designed to allow you to classically simulate the dynamics of any magnetic particle in a solution using given parameters about the particles and the solution. The code is licenced and available under the`BSD 3-Clause licence <https://opensource.org/licenses/BSD-3-Clause>`_

The PhD thesis associated with Mango can be viewed on the Queen’s University Belfast Research Portal `here <https://pure.qub.ac.uk/en/studentTheses/radio-frequency-heating-of-magnetic-perovskite-nanoparticles-in-s>`_.

.. video:: _static/example.mp4
   :width: 600
   :height: 456
   :autoplay:
   :loop:

Above is a visualisation of 5 MNPs in a periodic box at 300K in an implicit solvent with the viscosity of water. The mesh is the size of the particles (10nm radius), the central sphere allows for the viewing of the magnetisation (blue arrows) and force (red arrows) vectors.

Contents:

.. toctree::
   :maxdepth: 3

   Installation
   FirstRun
   SubmissionScript
   datafiles
   Plotting
   Mango
   Coverage

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

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