Skip to content

Commit

Permalink
Remove limitation on how entries are named (#1517)
Browse files Browse the repository at this point in the history
- Change all instances of <group type="NXentry" name="entry"> to <group type="NXentry"> (24 instances)
- Deprecate all instances of <attribute name="entry"> (6 instances)

Fixes #1438
  • Loading branch information
phyy-nx authored Dec 9, 2024
1 parent 5b6daa0 commit 368dd0f
Show file tree
Hide file tree
Showing 29 changed files with 23 additions and 48 deletions.
2 changes: 1 addition & 1 deletion applications/NXarchive.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
a mechanism to link all aspects of ISIS research from
proposal through to publication.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<attribute name="index"></attribute>
<field name="title" />
<field name="experiment_identifier" type="NX_CHAR">
Expand Down
6 changes: 0 additions & 6 deletions applications/NXarpes.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,6 @@
It has been drawn up with hemispherical electron analysers in mind.
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>
NeXus convention is to use "entry1", "entry2", ...
for analysis software to locate each entry.
</doc>
</attribute>
<field name="title" type="NX_CHAR"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXdirecttof.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd"
>
<doc>This is a application definition for raw data from a direct geometry TOF spectrometer</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXfluo.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<doc>
This is an application definition for raw data from an X-ray fluorescence experiment
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXindirecttof.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</symbol>
</symbols>
<doc>This is a application definition for raw data from an indirect geometry TOF spectrometer</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
3 changes: 0 additions & 3 deletions applications/NXiqproc.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@
</symbols>
<doc>Application definition for any :math:`I(Q)` data.</doc>
<group type="NXentry">
<attribute name="entry">
<!-- TODO documentation string needed here -->
</attribute>
<field name="title"/>
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXlauetof.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<doc>
This is the application definition for a TOF laue diffractometer
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXmonopd.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
with a single detector or a powder diffractometer with a position
sensitive detector.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXrefscan.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
It does not have the information to calculate the resolution
since it does not have any apertures.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="end_time" type="NX_DATE_TIME" />
Expand Down
2 changes: 1 addition & 1 deletion applications/NXreftof.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</symbol>
</symbols>
<doc>This is an application definition for raw data from a TOF reflectometer. </doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="end_time" type="NX_DATE_TIME" />
Expand Down
3 changes: 0 additions & 3 deletions applications/NXsastof.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,6 @@
at a time-of-flight source.
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>NeXus convention is to use "entry1", "entry2", ... for analysis software to locate each entry</doc>
</attribute>
<field name="title"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
Expand Down
1 change: 0 additions & 1 deletion applications/NXsqom.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
a sensible way.
</doc>
<group type="NXentry">
<attribute name="entry"> </attribute>
<field name="title"/>
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtas.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
It is for the trademark scan of the TAS, the Q-E scan.
For your alignment scans use the rules in :ref:`NXscan`.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" type="NX_CHAR" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtofnpd.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</symbol>
</symbols>
<doc>This is a application definition for raw data from a TOF neutron powder diffractometer</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtofraw.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</symbol>
</symbols>
<doc>This is an application definition for raw data from a generic TOF instrument</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtofsingle.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</symbol>
</symbols>
<doc>This is a application definition for raw data from a generic TOF instrument</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtomo.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
a number of dark field images are measured, some bright field images and, of course the sample.
In order to distinguish between them images carry a image_key.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" minOccurs="0" maxOccurs="1"/>
<field name="start_time" type="NX_DATE_TIME" minOccurs="0" maxOccurs="1"/>
<field name="end_time" type="NX_DATE_TIME" minOccurs="0" maxOccurs="1"/>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtomophase.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
some dark field images are measured, some bright field images and, of course the sample. In order
to properly sort the order of the images taken, a sequence number is stored with each image.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="end_time" type="NX_DATE_TIME" />
Expand Down
2 changes: 1 addition & 1 deletion applications/NXtomoproc.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
</symbol>
</symbols>
<doc>This is an application definition for the final result of a tomography experiment: a 3D construction of some volume of physical properties.</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
Expand Down
6 changes: 0 additions & 6 deletions applications/NXxas.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,6 @@
absorbed beam.
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>
NeXus convention is to use "entry1", "entry2", ...
for analysis software to locate each entry.
</doc>
</attribute>
<field name="title"/>
<field name="start_time" type="NX_DATE_TIME"/>
<field name="definition">
Expand Down
6 changes: 0 additions & 6 deletions applications/NXxasproc.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,6 @@
Processed data from XAS. This is energy versus I(incoming)/I(absorbed).
</doc>
<group type="NXentry">
<attribute name="entry">
<doc>
NeXus convention is to use "entry1", "entry2", ...
for analysis software to locate each entry.
</doc>
</attribute>
<field name="title"/>
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxbase.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<doc>
This definition covers the common parts of all monochromatic single crystal raw data application definitions.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="title" />
<field name="start_time" type="NX_DATE_TIME" />
<field name="definition">
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxeuler.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
of :ref:`NXxbase` plus the data defined here. All four angles are
logged in order to support arbitrary scans in reciprocal space.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxkappa.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
the content of :ref:`NXxbase` plus the
data defined here.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxlaue.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
This is the application definition for raw data from a single crystal laue
camera. It extends :ref:`NXxrot`.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxlaueplate.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
This is the application definition for raw data from a single crystal Laue
camera with an image plate as a detector. It extends :ref:`NXxlaue`.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxnb.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
logged in order to support arbitrary scans in
reciprocal space.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion applications/NXxrot.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
It extends :ref:`NXxbase`, so the full definition is the content of :ref:`NXxbase`
plus the data defined here.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc>Official NeXus NXDL schema to which this file conforms.</doc>
<enumeration>
Expand Down
2 changes: 1 addition & 1 deletion contributed_definitions/NXxpcs.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
that this XPCS data will be part of multi-modal data set that could involve e.g., :ref:`NXcanSAS` or
1D and/or 2D data.
</doc>
<group type="NXentry" name="entry">
<group type="NXentry">
<field name="definition">
<doc> Official NeXus NXDL schema to which this file conforms </doc>
<enumeration>
Expand Down

0 comments on commit 368dd0f

Please sign in to comment.