Verification tool for NCrystal installations
The ncrystal-verify package is non-binary package which is released along-side
each release of NCrystal, with an identical version number. It provides a single
command, ncrystal-verify, which can be used to validate that a particular
installation of NCrystal is functional and produces expected results. In case of
failure, ncrystal-verify ends with non-zero exit code.
Note that technically, the ncrystal-verify package depends on the
ncrystal-python package with the same version number. Therefore, doing
pip install ncrystal-verify should normally result in the appropriate version
of ncrystal-verify being installed.
Examples of usage:
- Launch with no arguments to require ALL tests to succeed. Tests that are
missing optional dependencies will count as failures.
$> ncrystal-verify - Only run tests with no missing dependencies. Those with missing optional
dependencies will be reported as skipped, and will NOT count as failures.
$> ncrystal-verify -m all - Get specific usage instructions:
$> ncrystal-verify --help
Referencing NCrystal in scientific work
A very substantial effort went into developing NCrystal. If you use it for your work, we would appreciate it if you would use the following primary reference in your work:
X.-X. Cai and T. Kittelmann, NCrystal: A library for thermal neutron transport, Computer Physics Communications 246 (2020) 106851, https://doi.org/10.1016/j.cpc.2019.07.015
For work benefitting from elastic physics (e.g. Bragg diffraction), we furthermore request that you additionally also use the following reference in your work:
T. Kittelmann and X.-X. Cai, Elastic neutron scattering models for NCrystal, Computer Physics Communications 267 (2021) 108082, https://doi.org/10.1016/j.cpc.2021.108082
For work benefitting from our inelastic physics, we furthermore request that you additionally also use the following reference in your work:
X.-X. Cai, T. Kittelmann, et. al., "Rejection-based sampling of inelastic neutron scattering", Journal of Computational Physics 380 (2019) 400-407, https://doi.org/10.1016/j.jcp.2018.11.043
1 maintainer
Metadata
1 maintainer
Release files for ncrystal-verify 4.4.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ncrystal_verify-4.4.6.tar.gz | 734.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ncrystal_verify-4.4.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / ncrystal_verify-4.4.6.tar.gz
| Download URL | ncrystal_verify-4.4.6.tar.gz |
|---|---|
| Size | 734.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9e076e57c3a22a272d8d5649d13059e4095754a43be3fc9afd0d5bddfa7daec5
|
|
BLAKE2b-256 checksum How to use checksums |
ffb11ac971b47dd1a06b29b506e4532e62c28d4111dea37a104222889df00d56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 30, 2026.
Transparency logRelease files / ncrystal_verify-4.4.6-py3-none-any.whl
| Download URL | ncrystal_verify-4.4.6-py3-none-any.whl |
|---|---|
| Size | 906.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17000a012f38be0308b61d6d3545019374a95fc301fe394c15fa10ffd165606b
|
|
BLAKE2b-256 checksum How to use checksums |
c20eeedffe14b20ac55d8674e94cb6478d1af8ec9eca4dffdd9217261aa70fca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 30, 2026.
Transparency log
