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

1170 nxxas documentation improvement #1190

Merged
merged 5 commits into from
Sep 15, 2022

Conversation

benajamin
Copy link
Contributor

fixes #1170 with minimal changes.

@benajamin benajamin linked an issue Sep 15, 2022 that may be closed by this pull request
@benajamin benajamin self-assigned this Sep 15, 2022
@benajamin benajamin requested a review from a team September 15, 2022 07:44
@benajamin benajamin added the NIAC should review The NIAC should review/discuss label Sep 15, 2022
applications/NXxas.nxdl.xml Outdated Show resolved Hide resolved
applications/NXxas.nxdl.xml Show resolved Hide resolved
@prjemian prjemian added this to the NXDL 2023.06 milestone Sep 15, 2022
@woutdenolf woutdenolf self-requested a review September 15, 2022 12:59
@prjemian
Copy link
Contributor

prjemian commented Sep 15, 2022

Suggest adding some versioning information, such as this from NXentry:

<field name="definition">
<doc>
(alternate use: see same field in :ref:`NXsubentry` for preferred)
Official NeXus NXDL schema to which this entry conforms which must be
the name of the NXDL file (case sensitive without the file extension)
that the NXDL schema is defined in.
For example the ``definition`` field for a file that conformed to the
*NXarpes.nxdl.xml* definition must contain the string **NXarpes**.
This field is provided so that :ref:`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 :ref:`NXsubentry`, instead, as the overlay position.
</doc>
<attribute name="version"><doc>NXDL version number</doc></attribute>
<attribute name="URL"><doc>URL of NXDL file</doc></attribute>
</field>

@prjemian
Copy link
Contributor

See #1038 for question on versioning

Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@benajamin
Copy link
Contributor Author

Proposal is to accept the changes to NXxas in pull request #1190

@benajamin benajamin added NIAC approved and removed NIAC should review The NIAC should review/discuss labels Sep 15, 2022
@benajamin benajamin merged commit 370af53 into main Sep 15, 2022
@benajamin benajamin deleted the 1170-nxxas-documentation-improvement branch September 15, 2022 14:05
@padraic-shafer
Copy link
Contributor

Hi, I'm late to the party here but wanted to say that these look like positive changes, and I'd like to find a way to keep this list of NXxas/DATA/modes up-to-date.

In the near term, we would like to see "Luminescence Yield" added as option. I think it would it would be helpful to include an "OTHER" such as "Other Transmissive" and "Other Absorptive" as additional expansion options.

In the next month or so, we'll be submitting a follow-up enhancement of the NXxas definition that supports multi-detector measurements. Simply wanted to add a placeholder before anything gets backward incompatible.

Suggestions are welcome!

@PeterC-DLS PeterC-DLS modified the milestones: NXDL 2023.06, NXDL 2023.10 Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

NXxas documentation improvement
5 participants