Skip to content

move optical spectroscopy files to applications/base_classes#397

Merged
lukaspie merged 1 commit into
fairmatfrom
fairmat-optspec-updated
Jul 21, 2025
Merged

move optical spectroscopy files to applications/base_classes#397
lukaspie merged 1 commit into
fairmatfrom
fairmat-optspec-updated

Conversation

@lukaspie
Copy link
Copy Markdown
Collaborator

@lukaspie lukaspie commented Jul 18, 2025

This brings back the changes as accepted by NIAC in nexusformat#1425

Summary by Sourcery

Move optical spectroscopy application and base class definitions into their appropriate applications and base_classes directories and clean up outdated metadata

Enhancements:

  • Relocate NXraman, NXoptical_spectroscopy, and NXellipsometry application definitions from contributed_definitions to applications
  • Move NXoptical_window, NXbeam_transfer_matrix_table, and NXwaveplate definitions into base_classes
  • Remove obsolete commented TODO blocks and draft metadata from relocated YAML and XML files
  • Update SHA hash values to reflect the moved definitions

Documentation:

  • Fix minor typos in documentation text

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jul 18, 2025

Reviewer's Guide

This PR reorganizes the optical spectroscopy definitions by relocating application and base‐class YAML and NXDL files into the new applications/ and base_classes/ directories, and cleans up legacy comments and metadata.

Class diagram for updated location of optical spectroscopy base classes and applications

classDiagram
    class NXoptical_spectroscopy {
        <<application>>
    }
    class NXraman {
        <<application>>
    }
    class NXellipsometry {
        <<application>>
    }
    class NXoptical_window {
        <<base_class>>
    }
    class NXbeam_transfer_matrix_table {
        <<base_class>>
    }
    class NXwaveplate {
        <<base_class>>
    }
    NXraman --|> NXoptical_spectroscopy
    NXellipsometry --|> NXoptical_spectroscopy
    NXoptical_window --|> NXaperture
    NXbeam_transfer_matrix_table --|> NXobject
    NXwaveplate --|> NXcomponent
    %% Note: Only class locations and inheritance are shown, as the PR is a reorganization.
Loading

File-Level Changes

Change Details Files
Reorganize application definitions
  • Move NXraman, NXoptical_spectroscopy, NXellipsometry YAML files to applications/nyaml
  • Move corresponding NXDL group definitions to applications/
applications/nyaml/NXraman.yaml
applications/nyaml/NXoptical_spectroscopy.yaml
applications/nyaml/NXellipsometry.yaml
applications/NXraman.nxdl.xml
applications/NXoptical_spectroscopy.nxdl.xml
applications/NXellipsometry.nxdl.xml
Reorganize base class definitions
  • Move NXoptical_window, NXbeam_transfer_matrix_table, NXwaveplate YAML to base_classes/nyaml
  • Move corresponding NXDL definitions to base_classes/
base_classes/nyaml/NXoptical_window.yaml
base_classes/nyaml/NXbeam_transfer_matrix_table.yaml
base_classes/nyaml/NXwaveplate.yaml
base_classes/NXoptical_window.nxdl.xml
base_classes/NXbeam_transfer_matrix_table.nxdl.xml
base_classes/NXwaveplate.nxdl.xml
Clean up and update metadata
  • Remove outdated draft/TODO comment blocks
  • Refresh SHA hash comments to match new revisions
  • Fix minor typos (e.g., duplicate words)
applications/nyaml/NXraman.yaml
applications/nyaml/NXoptical_spectroscopy.yaml
applications/nyaml/NXellipsometry.yaml
applications/NXraman.nxdl.xml
applications/NXoptical_spectroscopy.nxdl.xml
applications/NXellipsometry.nxdl.xml
base_classes/nyaml/NXoptical_window.yaml
base_classes/nyaml/NXbeam_transfer_matrix_table.yaml
base_classes/nyaml/NXwaveplate.yaml
base_classes/NXoptical_window.nxdl.xml
base_classes/NXbeam_transfer_matrix_table.nxdl.xml
base_classes/NXwaveplate.nxdl.xml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]

This comment was marked as resolved.

Copy link
Copy Markdown
Collaborator

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

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

These updates on the definitions are consistent with what I found that needs to be carried over from the NIAC, so this lgtm.

Only one question though: What happened to the optical_spectroscopy.rst in the coordinating context descriptions in contributed_definitions?
Do you plan to copy this over with the others later?

@lukaspie
Copy link
Copy Markdown
Collaborator Author

Only one question though: What happened to the optical_spectroscopy.rst in the coordinating context descriptions in contributed_definitions? Do you plan to copy this over with the others later?

I will only touch the rst files in nexusformat#1428 and then move them over later, it doesn't make sense to make changes here that will anyway be overwritten again in that PR.

Copy link
Copy Markdown
Collaborator

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

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

doing it with nexusformat#1428 is fine for the rst part

@lukaspie lukaspie merged commit b537b2d into fairmat Jul 21, 2025
6 checks passed
@lukaspie lukaspie deleted the fairmat-optspec-updated branch July 21, 2025 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants