pace-neutrons 0.3.1

A Python wrapper around Matlab programs for inelastic neutron scattering data analysis

PACE-neutrons

PACE is a suite of programs for data analysis of inelastic neutron scattering spectra, written in both Python and Matlab.

The packages included in PACE are:

• Horace - A Matlab program for the visualisation and analysis of large datasets from time-of-flight neutron inelastic scattering spectrometers.
• Euphonic - A Python program for simulating phonon spectra from DFT output (CASTEP or Phonopy).
• Brille - A C++/Python program for Brillouin zone interpolation.
• SpinW - A Matlab program for simulating spin wave (magnon) spectra.

The Python programs have separate PyPI packages (Euphonic and Brille), whilst this package provides a Python module for the Matlab codes using a compiled Matlab library, which does not require a Matlab license.

Getting Started

You can install and run the package using:

pip install pace_neutrons
pace_neutrons

When you first run pace_neutrons the module will check to see if you have the Matlab Compiler Runtime (MCR) installed. If you do not have the version required by PACE (currently R2020a) then the program will prompt you to accept the Matlab license and it will download and install the required MCR components (approximately 500MB download, 2GB installed). Note that the installation is silent and may take some time to download and install (~15-30min). You can also manually install the MCR at the above link, but note that the distributions linked there is for the full Matlab installation including all toolboxes, which is approximately 2.5GB to download and 15GB installed.

After installing the MCR, the program will start a Python command line. To use PACE you must first import and initialise the Matlab module as follows:

from pace_neutrons import Matlab
m = Matlab()

Thereafter, you can use the Matlab-based commands of Horace or SpinW by prefixing them with m., e.g.:

proj = m.projaxes([-0.5, 1, 0], [0, 0, 1], 'type', 'rrr')
w1 = m.cut_sqw('ei30_10K.sqw', proj, [0.1, 0.02, 0.5], [1.5, 2.5], [0.4, 0.5], [3, 0.5, 20])
hf = m.plot(w1)

You can get further help from the Horace or SpinW webpages.

Finally if you have Jupyter or Spyder installed you can start a PACE session in either with:

pace_neutrons --jupyter

or

pace_neutrons --spyder

Developer notes

Developer documentation is here