Dans_Diffraction.classes_structures (version 1.2)
index
c:\users\grp66007\onedrive - diamond light source ltd\pythonprojects\dans_diffraction\dans_diffraction\classes_structures.py

CIF Directory
Various standard structures to load into Dans_Diffraction.
 
Usage:
    from classes_structures import Structures
    structure_list = Structures() # builds database of all cif files in Structures Directory
    xtl = structure_list.Silicon() # builds Crystal class of selected structure
    all_xts = [xtl for xtl in structure_list]
 
By Dan Porter, PhD
Diamond
2018
 
Version 1.2
Last updated: 18/08/23
 
Version History:
02/03/18 1.0    Program created
07/08/19 1.1    Added __call__ and __repr__ methods
18/08/23 1.2    Added __getitem__ to Structures class
 
@author: DGPorter

 
Modules
       
glob
numpy
os
sys

 
Classes
       
builtins.object
BuildCrystal
Structures

 
class BuildCrystal(builtins.object)
    BuildCrystal(filename)
 
Storage Class for filename and build command
Builds a Crystal class.
 
  Methods defined here:
__call__(self)
Call self as a function.
__init__(self, filename)
Initialize self.  See help(type(self)) for accurate signature.
__repr__(self)
Return repr(self).
__str__(self)
Return str(self).
build(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Structures(builtins.object)
    Provides a database of cif files
    S = Structures() # builds database
    xtl = S.Diamond.build()
    
    Use S.list to see the available structures
    Use S.cif_files to see filenames of structures
 
    Iterating over all structures:
    for xtl in S:
        print(xtl)
 
  Methods defined here:
__getitem__(self, item)
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).
info(self)
"Print Available Structures

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
cif_list()
"Returns a list of cif files in the current directory