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:

  1. Launch with no arguments to require ALL tests to succeed. Tests that are missing optional dependencies will count as failures. 
    $> ncrystal-verify
  2. 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
  3. 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

Project links

Data verified by PyPI on Jun 30, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for thomaskittelmann from gravatar.com thomaskittelmann

Credits

Author: NCrystal developers (Thomas Kittelmann, Xiao Xiao Cai)

GitHub Statistics

Data verified by PyPI on Jun 30, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache License)

Requires

Python >=3.8

Provides Extra

all

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ncrystal_verify-4.4.6.tar.gz (734.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ncrystal_verify-4.4.6-py3-none-any.whl (906.2 kB view details)

Uploaded Python 3

File details

Details for the file ncrystal_verify-4.4.6.tar.gz.

File metadata

  • Download URL: ncrystal_verify-4.4.6.tar.gz
  • Upload date:
  • Size: 734.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for ncrystal_verify-4.4.6.tar.gz
Algorithm Hash digest
SHA256 9e076e57c3a22a272d8d5649d13059e4095754a43be3fc9afd0d5bddfa7daec5
MD5 a67471b0a639b410bcaa4d03a6751ad0
BLAKE2b-256 ffb11ac971b47dd1a06b29b506e4532e62c28d4111dea37a104222889df00d56

See more details on using hashes here.

Provenance

The following attestation bundles were made for ncrystal_verify-4.4.6.tar.gz:

Publisher: pypi.yml on mctools/ncrystal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ncrystal_verify-4.4.6-py3-none-any.whl.

File metadata

  • Download URL: ncrystal_verify-4.4.6-py3-none-any.whl
  • Upload date:
  • Size: 906.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for ncrystal_verify-4.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 17000a012f38be0308b61d6d3545019374a95fc301fe394c15fa10ffd165606b
MD5 7c87eda3d1630ad76f8f9f1ca042ef32
BLAKE2b-256 c20eeedffe14b20ac55d8674e94cb6478d1af8ec9eca4dffdd9217261aa70fca

See more details on using hashes here.

Provenance

The following attestation bundles were made for ncrystal_verify-4.4.6-py3-none-any.whl:

Publisher: pypi.yml on mctools/ncrystal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.4.6 This release

2 files

4.4.4

2 files

4.4.2

2 files

4.4.0

2 files

4.3.4

2 files

4.3.2

2 files

4.3.0

2 files

4.2.12

2 files

4.2.10

2 files

4.2.8

2 files

4.2.6

2 files

4.2.4

2 files

4.2.2

2 files

4.2.0

2 files

4.1.8

2 files

4.1.6

2 files

Yanked

4.1.5

2 files

4.1.4

2 files

4.1.2

2 files

4.1.0

2 files

4.0.2

2 files

4.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page