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.

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. (DOI: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

SANSND

Small Angles Neutron Scattering for NanoDiamonds.

• 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

CrysText

A plugin providing texture models. Warning: The data files from this plugin will currently fail to load as isotropic materials, needing dir1, dir2 and mos parameters. Additionally there are some known numerical issues.

• WARNING: ncrystal-pluginmanager --test CrysText is currently failing for this plugin
• Install with: pip install "git+https://github.com/highness-eu/ncplugin-CrysText"
• Source URL: https://github.com/highness-eu/ncplugin-CrysText

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@tk_volatile#subdirectory=examples/plugin_dataonly"
• Source URL: https://github.com/mctools/ncrystal/tree/tk_volatile/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@tk_volatile#subdirectory=examples/plugin"
• Source URL: https://github.com/mctools/ncrystal/tree/tk_volatile/examples/plugin