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: additional base classes in NXinstrument #1419

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

lukaspie
Copy link
Contributor

@lukaspie lukaspie commented Sep 23, 2024

This PR adds four unnamed base classes to NXinstrument.

  • NXactuator: see description/discussion in Fairmat 2024: actuators and sensors in NXenvironment #1414
  • NXfabrication: see description/discussion in Fairmat 2024: actuators and sensors in NXenvironment #1414
  • NXhistory: this is a new base class that is meant to describe the history of any physical object (in this case, the instrument history). NXhistory is meant to contain many instances of the new base class NXactivity, which describes any physical activity that was performed on the physical entity prior or during the experiment. Note this is intentionally different than NXprocess, which describes processing of the data.
  • NXresolution: This is meant to describe the resolution of a measureable physical quantity. Here, we are describing many different ways of a) how such a resolution can be described, and b) how such a resolution can be obtained. For b), we are also moving the base class NXcalibration (a subclass of NXprocess) from contributed to base_classes and slightly expand its former definition .

In addition, NXnote is expanded to contain more information about a given resource (like the URI of the resource, the checksum of a file, etc.).

@lukaspie lukaspie marked this pull request as draft September 23, 2024 16:45
@lukaspie lukaspie changed the title Fairmat 2024: additional base classes in NXinstrument FAIRmat 2024: additional base classes in NXinstrument Sep 23, 2024
@lukaspie lukaspie force-pushed the fairmat-2024-nxinstrument branch from 64226dd to 5f5b269 Compare September 23, 2024 16:53
@sanbrock sanbrock mentioned this pull request Sep 29, 2024
@lukaspie lukaspie linked an issue Sep 29, 2024 that may be closed by this pull request
@lukaspie lukaspie force-pushed the fairmat-2024-nxinstrument branch from cd9fa25 to 254fc4a Compare January 9, 2025 15:05
@lukaspie
Copy link
Contributor Author

lukaspie commented Jan 9, 2025

@phyy-nx I also made one more change in that I changed the links in the NXcalibration docs to point correctly to the concepts in NXdata:
image

@lukaspie lukaspie force-pushed the fairmat-2024-nxinstrument branch from 2f4276e to e42023a Compare January 16, 2025 08:03
lukaspie added a commit to FAIRmat-NFDI/nexus_definitions that referenced this pull request Jan 16, 2025
@phyy-nx
Copy link
Contributor

phyy-nx commented Jan 27, 2025

Ready for final review and merge.

@phyy-nx phyy-nx assigned phyy-nx and unassigned phyy-nx Jan 27, 2025
@PeterC-DLS PeterC-DLS self-assigned this Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NIAC approved NIAC should review The NIAC should review/discuss
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NXinstrument
8 participants