Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add NeXus Constructor and nxdl_to_hdf5.py #1085

Merged
merged 2 commits into from
Jun 15, 2022
Merged

add NeXus Constructor and nxdl_to_hdf5.py #1085

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
416277c
add NeXus Constructor and nxdl_to_hdf5.py
benajamin Jun 14, 2022
ce7151f
DOC #1085 deeper description
prjemian Jun 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions manual/source/utilities.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,28 @@ The list is not intended to be a complete list of all available packages.
See the program documentation for more details:
https://punx.readthedocs.io

Other Utilities
###############

.. index::
NeXus Constructor

**NeXus Constructor** (https://github.com/ess-dmsc/nexus-constructor)
The NeXus Constructor facilitates constructing NeXus files in which to record data from
experiments at neutron science facilities. This includes all supporting metadata typically
required to perform analysis of such experiments, including instrument geometry information.

.. index::
nxdl_to_hdf5.py

**nxdl_to_hdf5.py** (https://github.com/nexusformat/exampledata/tree/master/nxdl)
``nxdl_to_hdf5.py`` is a Python script that reads the NeXus definition files
(files ending with ``.nxdl.xml``) and creates example Python scripts as well
as HDF5 files for each definition. There are generated example scripts of
each application definition for both *h5py* and *nexusformat*. Currently, only
application definitions and some contributed_definitions are supported as
the code depends on the existence of an :ref:`NXentry` in the definition.

Data Analysis
#############

Expand Down