index.rst

Welcome to open-moldyn's documentation!

Presentation

Open-moldyn is the result of an internship project at the IPR (Institut de Physique de Rennes) aiming at creating an (hopefully) fast and easy to use 2D molecular dynamics simulation tool with python.

This tool features a GUI (graphical interface) and is meant to be installed with pip (as every respectable python packages should be).

Some links bellow:

• Github repository : https://github.com/open-moldyn/moldyn
• PyPI depot : https://pypi.org/project/open-moldyn/

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

   simulation
   processing
   utils

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`

Credits

Open-moldyn is made by Alexandre Faye-Bedrin and Arthur Luciani (at the time students of the ENS Rennes and interns of the IPR) with the supervision of Yann Gueguen.

This package also includes datreant and appdirs to help managing data and files.