Skip to main content

Generate diffracted intensities from crystals

Project description


Reads crystallographic cif files and simulates diffraction

Version 1.x

By Dan Porter, Diamond Light Source 2018


$ ipython -i -m Dans_Diffraction
import Dans_Diffraction as dif
xtl = dif.Crystal('some_file.cif') # print Crystal structure parameters

# Print reflection list:

# Plot Powder pattern:

# Start graphical user interface:

Full code documentation available here.

For comments, queries or bugs - email


Requirements: Python 2.7+/3+ with packages: Numpy, Matplotlib, Scipy, Tkinter

Stable version from PyPI:

$ pip install Dans-Diffraction

Latest version from GitHub:

$ git clone


Dans_Diffraction is best run within an interactive python environment:

$ ipython -i -m Dans_Diffraction

Dans_Diffraction can also be run in scripts as an import, example scripts are provided in the Examples folder.

Read CIF file

import Dans_Diffraction as dif
xtl = dif.Crystal('some_file.cif') # print Crystal structure parameters

Alter atomic positions

xtl.Cell.latt([2.85,2.85,10.8,90,90,120]) #  set lattice parameters # Print Symmetric positions # Print All positions in P1 symmetry (same structure and functions as xtl.Atoms)
# Symmetric positions
xtl.Atoms.changeatom(idx=0, u=0, v=0, w=0, type='Co', label='Co1')
xtl.Atoms.addatom(idx=0, u=0, v=0, w=0, type='Co', label='Co1')
# After adding or changing an atom in the Atoms class, re-generate the full structure using symmetry arguments:
# Full atomic structure in P1 symmetry
xtl.Structure.changeatom(idx=0, u=0, v=0, w=0, type='Co', label='Co1')
xtl.Structure.addatom(idx=0, u=0, v=0, w=0, type='Co', label='Co1')
# Plot crystal Structure
xtl.Plot.plot_crystal() # 3D plot
xtl.Plot.plot_layers() # 2D plot for layered materials

3D Plot

Alter crystal symmetry # print symmetry arguments
xtl.Symmetry.addsym('x,y,z+1/2') # adds single symmetry operation
xtl.Symmetry.changesym(0, 'x,y,z+1/4')
# After adding or changing symmetry operations, regengerate the symmetry matrices

Calculate Structure Factors

X-ray or neutron structure factors/ intensities are calculated based on the full unit cell structure, including atomic form-factors (x-rays) or coherent scattering lengths (neutrons).

# Choose scattering options (see help(xtl.Scatter.setup_scatter))
xtl.Scatter.setup_scatter(type='x-ray', energy_keV=8.0)
# Allowed radiation types:
#    'xray','neutron','xray magnetic','neutron magnetic','xray resonant'
xtl.intensity([h,k,l]) # Returns intensity
xtl.print_all_refelctions() # Returns formated string of all allowed reflections
# Plot Experimental Intensities
xtl.Plot.simulate_powder() # Powder pattern
xtl.Plot.simulate_hk0() # Reciprocal space plane

Powder Pattern HK0 Simulation

Magnetic scattering is also available for neutrons and x-rays (both resonant and non-resonant), using the appropriate magnetic form-factors.

Imag = xtl.Scatter.magnetic_neutron(HKL=[0,0,3])
Ires = xtl.Scatter.xray_resonant_magnetic(HKL=[0,0,3], energy_kev=2.838, azim_zero=[1, 0, 0], psi=0, polarisation='s-p', F0=0, F1=1, F2=0)

Multiple Scattering

Simulations of multiple scattering at different azimuths for a particular energy can be simulated. Based on code by Dr Gareth Nisbet.

azimuth, intensity = xtl.Scatter.ms_azimuth([h,k,l], energy_kev=8)

Multiple Scattering


The Crystal class contains a lot of atomic properties that can be exposed in the Properties class:

All the properties are stored in the folder Dans_Diffraction/data.


Superstructures can be built using the Superstructure class, requring only a matrix to define the new phase:

su = xtl.generate_superstructrue([[2,0,0],[0,2,0],[0,0,1]])

Superstucture classes behave like Crystal classes, but have an additional 'Parent' property that references the original crystal structure and additional behaviours partiular to superstructures. # Parent structure
su.P # superstructure matrix 

Graphical Front End

All GUI elements

Start a new GUI, then select a cif file:


Using an already generated crystal:


FDMNES functionality

FDMNES is a powerful tool for simulating resonant x-ray diffraction, created by Y. Joly and O. Bunau.

The Dans_Diffraction FDMNES class allows for the automatic creation of input files and simple analysis of results. The following command should be used to activate these features (only needs to be issued once).


Once activated, the FDMNES classes become available.

fdm = dif.Fdmnes(xtl) # Create input files and run FDMNES
fdma = dif.FdmnesAnalysis(output_path, output_name) # Load output files and plot results

See class documentation for more information.

Once activated, FDMNES GUI elements become available from the main window, emulating functionality of the classes.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Dans-Diffraction, version 1.5.2
Filename, size File type Python version Upload date Hashes
Filename, size Dans_Diffraction-1.5.2-py3-none-any.whl (2.1 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size Dans_Diffraction-1.5.2.tar.gz (2.0 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page