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.

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

Fairmat 2024: add attributes to NXroot #1418

Merged
merged 18 commits into from
Oct 22, 2024
Merged
Changes from 9 commits
Commits
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
31 changes: 27 additions & 4 deletions base_classes/NXroot.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,39 @@
<attribute name="file_update_time" type="NX_DATE_TIME">
<doc>Date and time of last file change at close</doc>
</attribute>
<attribute name="NeXus_repository">
<doc>
A repository containing the application definitions
used for creating this file.
If the NeXus_version attribute contains a commit distance and hash
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
this should refer to this repository.
</doc>
</attribute>
<attribute name="NeXus_version">
<doc>
Version of NeXus API used in writing the file.
Version of NeXus definitions used in writing the file.
This may either be a date based version tag of the form `vYYYY.MM`
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
or a version tag with a commit distance and source control (e.g., git) hash of
the form `vYYYY.MM.post1.dev&lt;commit-distance&gt;.g&lt;git-hash&gt;`.
It may contain an additional `.dYYYYMMDD` timestamp appendix
for dirty repositories.
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
If the version contains a commit distance and hash the
PeterC-DLS marked this conversation as resolved.
Show resolved Hide resolved
NeXus_repository attribute should be written with the
repository url containing this version.

Only used when the NAPI has written the file.
Only used when the NAPI or pynxtools has written the file.
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
Note that this is different from the version of the
base class or application definition version number.
</doc>
</attribute>
<attribute name="partial">
<doc>
A list of concepts in an application definition this file describes.
This is for partially filling an application definition.
If this attribute is not present the application definition is assumed
to be valid, if not only the specified concepts/paths are assumed to be valid.
</doc>
</attribute>
lukaspie marked this conversation as resolved.
Show resolved Hide resolved
<attribute name="HDF_version">
<doc>Version of HDF (version 4) library used in writing the file</doc>
</attribute>
Expand Down Expand Up @@ -101,5 +125,4 @@
for a summary of the discussion.
</doc>
</attribute>
</definition>

</definition>
Loading