search

nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 56 forks source link

Documentation review #886

Closed hgoerzig closed 2 years ago

hgoerzig commented 3 years ago

Review existing documentation considering understandability for newbies. Discussions can be found here: https://github.com/nexusformat/NIAC/issues/83

gerrit-guenther commented 3 years ago

NXsubentry: The use of NXsubentry could be fleshed out. Should it only be used when the instrument would apply to different techniques/application definitions or is it intended to be a general approach (e.g. using a NXfluo subentry in a NXfluo entry)? What about the entry/definition attribute which is mandatory - what to write here if there are two subentries for e.g. SAXS/WAXS?

Since the sample is defined for each subentry the subentry can apply to different measurements, different setups... Are there suggestions when to use NXentry or NXsubentry?

gerrit-guenther commented 3 years ago

NX_ANGLE: units of angle, example(s): m - what does m mean? https://manual.nexusformat.org/nxdl-types.html#nx-angle

PeterC-DLS commented 3 years ago

NX_ANGLE: units of angle, example(s): m - what does m mean? https://manual.nexusformat.org/nxdl-types.html#nx-angle

Looks like a mistake. Fix in #888

gerrit-guenther commented 3 years ago

NXsubentry: The use of NXsubentry could be fleshed out. Should it only be used when the instrument would apply to different techniques/application definitions or is it intended to be a general approach (e.g. using a NXfluo subentry in a NXfluo entry)? What about the entry/definition attribute which is mandatory - what to write here if there are two subentries for e.g. SAXS/WAXS?

Since the sample is defined for each subentry the subentry can apply to different measurements, different setups... Are there suggestions when to use NXentry or NXsubentry?

Heike refered to https://manual.nexusformat.org/rules.html#nxsubentry-or-multi-method-data which gives a clear example how to use NXentry (and I was not aware of) - maybe a link from NXentry and index could be helpful?

gerrit-guenther commented 3 years ago

Nxentry/definition: "This field is provided so that NXentry can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes.

It is advised to use NXsubentry, instead, as the overlay position." https://manual.nexusformat.org/classes/base_classes/NXentry.html#nxentry

That seems to suggest to use NXsubentry in general/excessively, also for non-Multi-Method data - contrary to https://manual.nexusformat.org/rules.html#nxsubentry-or-multi-method-data ?

prjemian commented 2 years ago

All items identified have individual issues, some have been solved. Closing this issue.