niess
Table of Contents
Installation
pip install niess
License
niess is distributed under the terms of the BSD-3-Clause license.
Motivation
This package is intended to hold information about the Neutron Insruments of the European Spallation Source for use in defining Monte Carlo ray-tracing simulations, file-layout information for use by the ESS file-writers, and other yet-undefined uses; in a use-agnostic approach.
The information required about an instrument for McStas and NeXusStructure is
similar but not identical -- the latter attempts to hold all information needed to
produce a valid NeXus file, which requires geometry information inspired by the
McCode implementation used by McStas.
The two uses each have their own vocabulary, and the vocabulary used here is more
closely in line with that of McCode. The basic building block of the two uses
is the Comp in McCode and the NXclass in NeXus; here the term 'component' is
used to refer to such a building block.
Since there are sometimes slight differences between the 'same' Comp and NXclass
in how equivalent information is stored, niess is intended to be component-aware as
a single translation between the two is not possible globally.
Rather than attempting to store one implementation or the other, niess components
are an independent low-level representation of the properties of a component.
This representation can be written as a dictionary with pre-defined keys, and
it is intended that serializing to and deserializing from such a representation can be
used to provide calibrated instrument information to McStas and NeXusStructure.
Use
niess describes an instrument once, as calibration data, and emits it as a McStas
instrument, ESS NeXus Structure JSON, or CAD geometry:
from niess.bifrost import Primary, Tank
from niess.bifrost.parameters import primary_parameters, tank_parameters
from niess.instrument import Instrument, Mount
from niess.nexus import to_nexus_structure
from niess.nexus.bifrost import BIFROST_REGISTRY
bifrost = Instrument(name='bifrost', origin='sample_origin', parts=(
Mount(name='primary', content=Primary.from_calibration(primary_parameters())),
Mount(name='tank', content=Tank.from_calibration(tank_parameters()),
relative_to='sample_origin'),
))
structure = to_nexus_structure(bifrost, registry=BIFROST_REGISTRY)
Full documentation, including how to translate an existing McStas .instr into a
niess submodule and how to write your own NeXus translators, is at
https://mcdotstar.github.io/niess/.
1 maintainer
Metadata
1 maintainer
Release files for niess 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| niess-0.8.0.tar.gz | 741.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| niess-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 981.1 kB
Release files / niess-0.8.0.tar.gz
| Download URL | niess-0.8.0.tar.gz |
|---|---|
| Size | 741.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bfb347c5614962adf48f16fbeabd77552b210dac0df61198e2948d4962e64a71
|
|
BLAKE2b-256 checksum How to use checksums |
a487878e314cac6a5289c6b32fb5eaa404b62098056f2abd5f6785e6d0cce85e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 30, 2026.
Transparency logRelease files / niess-0.8.0-py3-none-any.whl
| Download URL | niess-0.8.0-py3-none-any.whl |
|---|---|
| Size | 240.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e3a8d16da1394f313370bbdfc1c2ffd0f7b893fe9754f82318cec467899b46e1
|
|
BLAKE2b-256 checksum How to use checksums |
14c90d9076203d0efae1f8160cee7d1bfd615947fab8f6c5265b010a230245c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 30, 2026.
Transparency log
