.. interfacemaster documentation master file, created by
   sphinx-quickstart on Thu Apr 14 02:57:29 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

interfacemaster documentation
===========================================

A python package building CSL or approximate CSL interfaces of any two lattices and computing cell of non-identical displacement (CNID).

Functions
###########################################

1. Searching for 3D and 2D CSLs by rotating along an axis;
2. Build an approximate CSL interface according to a pre-determined approximate disorientation;
3. Generate exact CSL interfaces;
4. Sampling RBT in CNID

How to cite
###########################################

If you use the interface_master, please cite the following articles [1][2].  

   [1] "interface_master: Python package building CSL and approximate CSL interfaces of any two lattices -- an effective tool for interface engineers"  
   Y. S. Xie, K. Shibata, and T. Mizoguchi,
   ArXiv:2211.15173 (https://arxiv.org/abs/2211.15173) 

   [2] "A brute-force code searching for cell of non-identical displacement for CSL grain boundaries and interfaces"  
   Y. S. Xie, K. Shibata, and T. Mizoguchi,  
   Comp. Phys. Comm. 273 (2022) 108260-1-8 (https://www.sciencedirect.com/science/article/pii/S0010465521003726)

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   install
   tutorials
   interfacemaster


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

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