.. _parmec-index:

PARMEC
======

.. raw:: html

  <iframe src="https://ghbtns.com/github-btn.html?user=parmes&repo=parmec&type=watch&count=true&size=large&v=2"
  allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>

Parmec is a prototype of a vectorized and task based discrete element software, implemented using
`ISPC <http://ispc.github.io>`_ and C++. This code is at an early stage of development and it is
only partially functional (see :ref:`implementation status <parmec-implementation_status>`). Parmec
can be used as a blueprint of a `DEM <https://en.wikipedia.org/wiki/Discrete_element_method>`_ code
implemented predominately in `ISPC <http://ispc.github.io>`_.

More details can be found in:

.. toctree::
   :maxdepth: 1

   Installation <installation>
   Running <running>
   Implementation status <implementation_status>
   Input commands <input_commands>
   Output files <output_files>