Commit 2f74bf40 authored by Sherri Hadian's avatar Sherri Hadian
Browse files

Changed the module description.

parent f1fbfad1
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -5,13 +5,13 @@ This module is a collection of functions that produce CSL properties.
When run from the terminal, the code runs in two modes.

 First mode:
  'python CSLgenerator.py u v w [limit]' ----->  Where the u v w are the
  'csl_generator.py u v w [limit]' ----->  Where the u v w are the
  indices of the rotation axis such as 1 0 0, 1 1 1, 1 1 0 and so on. The limit
  is the maximum Sigma of interest.
  (the limit by default: 100)

 Second mode:
 'python CSLgenerator.py u v w basis sigma [limit]' -----> Where basis is
 'csl_generator.py u v w basis sigma [limit]' -----> Where basis is
  either fcc, bcc, diamond or sc. You read the sigma of interest from the first
  mode run. The limit here refers to CSL GB inclinations. The bigger the limit,
  the higher the indices of CSL planes.
+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ to get the info necessary for your grain boundary of interest.
 values. For ex.: input the GB_plane of interest from  running the CSl_generator
 in the second mode. Once you have completed customizing the io_file, run:

 'python gb_generator.py io_file'
 'gb_generator.py io_file'
 """

import sys