CuratedPlugins

Curated list of plugins

On this page we maintain a curated list of plugins, known to the NCrystal developers and gauged to be of sufficient interest for the wider community. If we are missing something, please Contact us to add another plugin to the list (or simply open a PR adding your plugin to the list we maintain in this file).

For how to use plugins in general, consult the Plugins page.

GraphiticData

NCMAT data files for graphite oxides and fullerite (C60).

• Install with: pip install ncrystal-plugin-GraphiticData
• PyPI URL: https://pypi.org/project/ncrystal-plugin-GraphiticData
• Source URL: https://github.com/highness-eu/ncmat-graphitic

UraniumOxideData

Extra NCMAT data files for Uranium Oxide (UO2), with phonon densities optimised for various temperatures. Phonon density curves in the files are taken from: G. Noguere, et al., 2020 (https://doi.org/10.1103/PhysRevB.102.134312).

• Install with: pip install ncrystal-plugin-UraniumOxideData
• PyPI URL: https://pypi.org/project/ncrystal-plugin-UraniumOxideData
• Source URL: https://github.com/mctools/ncrystal-extra/tree/HEAD/pypkgs/ncrystal-plugin-UraniumOxideData

WaterData

Extra NCMAT data files for light and heavy water, covering a wider range of temperatures compared to what is found in the NCrystal standard library. The data files were based on ENDF/B-VIII.0 CAB scattering kernels by J.I. Márquez Damián, et. al. (https://doi.org/10.1016/j.anucene.2013.11.014).

• Install with: pip install ncrystal-plugin-WaterData
• PyPI URL: https://pypi.org/project/ncrystal-plugin-WaterData
• Source URL: https://github.com/mctools/ncrystal-extra/tree/HEAD/pypkgs/ncrystal-plugin-WaterData

BzScope

A plugin allowing coherent inelastic kernels for isotropic materials, thus foregoing the incoherent approximation. The actual upstream location of this plugin is https://code.ihep.ac.cn/cinema-developers/ncplugin-bzscope but we also keep a mirror at the provided GitHub location in order to reduce network latency issues.

• Install with: pip install "git+https://github.com/mctools/ncrystal-plugin-BzScope"
• Source URL: https://github.com/mctools/ncrystal-plugin-BzScope

ClathrateHydrateData

NCMAT data files of various clathrate hydrates, including paramagnetic effects of scattering on enclathrated O2 via the MagScat plugin.

• Install with: pip install "git+https://github.com/highness-eu/ncmat-clathrates"
• Source URL: https://github.com/highness-eu/ncmat-clathrates

CrysExtn

A plugin providing extinction models for polycrystalline matherials. Both Sabine's and Becker and Coppens' (BC) extinction models are implemented.

• Install with: pip install "git+https://github.com/XuShuqi7/ncplugin-CrysExtn"
• Source URL: https://github.com/XuShuqi7/ncplugin-CrysExtn

CrysText

A plugin providing texture models. Note that this plugin has some known numerical issues and is slow for shorter wavelengths.

• Install with: pip install "git+https://github.com/highness-eu/ncplugin-CrysText"
• Source URL: https://github.com/highness-eu/ncplugin-CrysText

MagScat

A plugin providing paramagnetic scattering in O2-clathrates, based on formulas by O. Zimmer (https://doi.org/10.1103/PhysRevC.93.035503).

• Install with: pip install "git+https://github.com/highness-eu/ncplugin-MagScat"
• Source URL: https://github.com/highness-eu/ncplugin-MagScat

SANSND

A plugin to provide small angle neutron scattering for nanodiamonds. Models and benchmarking are described in N. Rizzi, et al. (https://doi.org/10.1080/00295639.2023.2196926).

• Install with: pip install "git+https://github.com/highness-eu/ncplugin-SANSND"
• Source URL: https://github.com/highness-eu/ncplugin-SANSND

nxslib

NCrystal plugin for loading .nxs files. Also includes a small database of .nxs files.

• Install with: pip install "git+https://github.com/mctools/ncplugin_nxslib"
• Source URL: https://github.com/mctools/ncplugin_nxslib

DummyDataPlugin

A (silly) example from the NCrystal source repository, serving as a template for other plugins. This example shows how to create a plugin which only provides a static set of NCMAT files.

• Install with: pip install "git+https://github.com/mctools/ncrystal#subdirectory=examples/plugin_dataonly"
• Source URL: https://github.com/mctools/ncrystal/tree/HEAD/examples/plugin_dataonly

DummyPlugin

A (silly) example from the NCrystal source repository, serving as a template for other plugins. This example shows how to create a plugin which actually modifies scattering physics.

• Install with: pip install "git+https://github.com/mctools/ncrystal#subdirectory=examples/plugin"
• Source URL: https://github.com/mctools/ncrystal/tree/HEAD/examples/plugin