Abins v1¶

Credits¶

Author:

Krzysztof Dymkowski, Adam Jackson

Contributors:

Sanghamitra Mukhopadhyay, Elliot Oram, Leonardo Bernasconi, Leandro Liborio

Summary¶

Calculates inelastic neutron scattering against 1-D ω axis.

Properties¶

Description¶

Abins is a plugin for Mantid which allows scientists to compare experimental and theoretical inelastic neutron scattering spectra (INS).

Abins requires a file containing ab-initio phonon data to perform INS analysis. Several formats are supported for phonon modes containing frequency and displacement data at given q-points: CASTEP (.phonon), CRYSTAL (.out), GAUSSIAN (.log), DMOL3 (.outmol) or VASP (.xml). For VASP XML inputs, it is also permitted to use a “selective dynamics” in which some atoms are frozen. These would typically form a rigid substrate (e.g. a noble metal surface) for an adsorbed molecule of lightweight atoms, and are omitted from the calculated spectrum.

Alternatively, force-constants data can be provided and a fine q-point mesh will be sampled automatically. In this case the supported formats are CASTEP (.castep_bin generated with phonon_write_force_constants = True) and Phonopy (phonopy.yaml file generated with INCLUDE_ALL = .TRUE.)

The user may also provide an experimental file with measured dynamical structure factor S in order to directly compare theoretical and experimental spectra. Abins produces one dimensional INS spectrum that can be compared against TOSCA, IN1-LAGRANGE and similar instruments; a semi-empirical powder averaging model accounts for q- and energy-dependent intensity behaviour in this system. The user-input temperature value is included in a Debye-Waller term, recreating the intensity fall-off with increasing wavelength. More information about the implemented working equations can be found here.

After successful analysis a user obtains a Mantid Workspace Group which stores theoretical spectra (and, optionally, experimental data). Currently a user can produce theoretical spectra for given atoms (e.g. ‘atom_1’, the first atom listed in the input data) or types of atom (for example for benzene two element symbols: C, H) and for each quantum event (up to fourth order). Total theoretical spectra can also be generated, summing over all considered quantum events for that atom or element. The user can also produce a total spectrum for the whole considered system. The dynamical structure factor S is calculated for all atoms in the system and results are cached, so if no settings have been changed then subsequent runs of Abins can quickly create more Mantid Workspaces without re-calculating any spectra.

Abins is in constant development and suggestions for improvements are very welcome. For any such contributions please contact Dr. Sanghamitra Mukhopadhyay. If you are developing or hacking on Abins, see the Abins: Implementation details notes which outline some of the key conventions, practices and pitfalls.

If Abins is used as part of your data analysis routines, please cite the relevant reference [1].

Usage¶

Example - loading CASTEP phonon data:

benzene_wrk = Abins(AbInitioProgram="CASTEP", VibrationalOrPhononFile="benzene.phonon",
                    QuantumOrderEventsNumber="1")


for name in benzene_wrk.getNames():
    print(name)

Output:

benzene_wrk_C_total
benzene_wrk_C
benzene_wrk_H_total
benzene_wrk_H

Example - loading CRYSTAL phonon data:

wrk=Abins(AbInitioProgram="CRYSTAL", VibrationalOrPhononFile="b3lyp.out", QuantumOrderEventsNumber="1")

for name in wrk.getNames():
    print(name)

Output:

wrk_C_total
wrk_C
wrk_H_total
wrk_H
wrk_N_total
wrk_N
wrk_Na_total
wrk_Na
wrk_O_total
wrk_O

Example - calling AbINS with more arguments:

wrk_verbose=Abins(AbInitioProgram="CASTEP", VibrationalOrPhononFile="benzene.phonon",
                  ExperimentalFile="benzene_experimental.dat",
                  TemperatureInKelvin=10, BinWidthInWavenumber=1.0, SampleForm="Powder", Instrument="TOSCA",
                  Atoms="H, atom1, atom2", SumContributions=True, QuantumOrderEventsNumber="1", ScaleByCrossSection="Incoherent")

for name in wrk_verbose.getNames():
    print(name)

Output:

experimental_wrk
wrk_verbose_total
wrk_verbose_H_total
wrk_verbose_H
wrk_verbose_atom_1_total
wrk_verbose_atom_1
wrk_verbose_atom_2_total
wrk_verbose_atom_2

Categories: AlgorithmIndex | Simulation

Source¶

Python: Abins.py

References¶