Skip to content

Commit ec4826d

Browse files
lukaspiemkuehbach
authored andcommitted
Apply suggestions from code review
Co-authored-by: Markus Kühbach <mkuehbach@users.noreply.github.com>
1 parent e4903f0 commit ec4826d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/learn/pynxtools/nexus-definitions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
`pynxtools` converts experimental data into the NeXus format and validates the resulting files against NeXus application definitions. These definitions formally describe how experimental data and metadata must be structured in a NeXus file.
5+
`pynxtools` converts experimental data into the NeXus format and validates the resulting HDF5 files against NeXus application definitions. These definitions formally describe how experimental data and metadata must be structured in a NeXus file.
66

77
The NeXus definitions themselves are not part of the pynxtools source code. Instead, they are maintained in a dedicated repository and included in pynxtools as a Git submodule:
88

@@ -22,13 +22,13 @@ This page explains:
2222

2323
## What the NeXus definitions are
2424

25-
NeXus defines a standardized structure for scientific data. The structure is described in XML files written in the NeXus Definition Language (NXDL), which define:
25+
NeXus defines a standardized structure for scientific data. The structure is defined in XML files written in the NeXus Definition Language (NXDL). These XML files define:
2626

27-
- base classes (common structural components),
27+
- base classes (common structural components and respective semantic concepts),
2828
- application definitions (experiment-specific schemas),
2929
- contributed definitions from the community. These can be base classes or application definitions.
3030

31-
These definitions specify naming, hierarchy, required concepts, and allowed metadata for NeXus files.
31+
These definitions specify naming, hierarchy, constraints on the requiredness of individual concepts, and allowed metadata for NeXus files.
3232

3333
In practice, they serve as:
3434

@@ -113,7 +113,7 @@ The script provides a small abstraction over common Git submodule operations and
113113
./scripts/definitions.sh checkout <REV>
114114
```
115115

116-
`<REV>` can be any any Git ref resolvable by `git rev-parse` (e.g., a commit hash, a tag, or a branch name).
116+
`<REV>` can be any Git reference that is resolvable by `git rev-parse` (e.g., a commit hash, a tag, or a branch name).
117117
The behavior depends on the type:
118118

119119
| Revision type | Result |

0 commit comments

Comments
 (0)