Permalink
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (20 sloc) 816 Bytes

Welcome to kmos's documentation!

img/kmos_structure.png

Things you can do with kmos.

kmos is a vigorous attempt to make (lattice) kMC modelling more accessible.

kmos is designed for and by kMC model developers. As of this writing there is no standardized way to develop kMC models, thus there is no standardized way to use kmos. kmos can be an Editor, an API, a viewer. However all in all kmos wants to save time filled with repetitive labor and enlarge your stride.

Not sure how to begin? Start with the :ref:`API tutorial <api-tutorial>`.

.. toctree::
   :maxdepth: 0

   tutorials/index
   topic_guides/index
   reference/index
   troubleshooting/index
   troubleshooting/faq

This document was generated Jul 17, 2018.