.. GB Kinetics documentation master file, created by
   sphinx-quickstart on Thu Aug  7 15:05:50 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GB Kinetics documentation!
=======================================

GB Kinetics is an open source python library to explore mechanisms for Grain Boundary (GB) migration mediated
by nucleation and glide of disconnections. Some key features are:

#. Generation of bicrystals using bicrystallographic data from oILAB.

#. Exploration of energy landscape of GB microstates using :math:`\gamma`-surface method.

#. Creation of atomic configurations for motion of GB due to nucleation and glide of any disconnection mode.

#. Calculation of Minimum energy path (MEP) GB motion using Nudged Elastic Band (NEB) method.

For citing the GB Kinetics project, consider the reference

Himanshu Joshi, Ian Chesser, Brandon Runnels, and Nikhil Chandra Admal.
"Energetics of the nucleation and glide of disconnection modes in symmetric tilt grain boundaries."
arXiv preprint arXiv:2504.16854 (2025).doi : https://doi.org/10.48550/arXiv.2504.16854

Author:
Himanshu Joshi

.. note::
   This repository is under active development.

Contents
--------
.. toctree::
   :maxdepth: 1

   download
   usage
   theory
   data
   example_gs
   example_gbkinetics
   modules

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

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