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.

Sign up for GitHub

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

Jump to bottom

151 integration of transmission plugin #155

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

151 integration of transmission plugin #155

wants to merge 1 commit into from

Conversation

ka-sarthak
Copy link
Collaborator

@ka-sarthak ka-sarthak commented Jan 9, 2025 •
edited by sourcery-ai bot
Loading

The following quantities and sub-sections will be renamed and newly defined:

  • transmission_settings.monochromator > transmission_settings.monochromators
  • transmission_settings.lamp > transmission_settings.light_sources
  • transmission_settings.detector > transmission_settings.detectors

The following quantities and sub-sections will only be renamed:

  • transmission_settings.accessory > transmission_settings.accessories

The following quantities and sub-sections will be added:

  • transmission_settings.monochromator_slit_width
  • transmission_settings.detector_gain
  • transmission_settings.detector_integration_time

The following quantities and sub-sections will be dropped:

  • results/0/extinction_coefficient

Summary by Sourcery

Integrate transmission plugin and update schema and test data.

New Features:

  • Add support for transmission measurements.

Tests:

  • Add new test files for transmission measurements.

@ka-sarthak ka-sarthak linked an issue Jan 9, 2025 that may be closed by this pull request
Integration of transmission plugin #151
Open
2 tasks
@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Jan 9, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request integrates the transmission plugin by renaming and redefining certain quantities and sub-sections within the transmission_settings schema. It also introduces new quantities, drops obsolete ones, and adds support for raw data files.

Class diagram showing changes to transmission settings structure

classDiagram
    class TransmissionSettings {
        +monochromators
        +light_sources
        +detectors
        +accessories
        +monochromator_slit_width
        +detector_gain
        +detector_integration_time
    }
    note for TransmissionSettings "Renamed and new fields added"

    class OldTransmissionSettings {
        +monochromator
        +lamp
        +detector
        +accessory
        +extinction_coefficient
    }

    OldTransmissionSettings ..> TransmissionSettings : Refactored to
Loading

File-Level Changes

Change Details Files
Renamed and redefined schema quantities related to monochromator, lamp, and detector.
  • transmission_settings.monochromator renamed to transmission_settings.monochromators
  • transmission_settings.lamp renamed to transmission_settings.light_sources
  • transmission_settings.detector renamed to transmission_settings.detectors
 src/nomad_measurements/transmission/schema.py
Renamed transmission_settings.accessory to transmission_settings.accessories.
  • Renamed schema quantity for accessories
 src/nomad_measurements/transmission/schema.py
Added new quantities to the schema.
  • Added transmission_settings.monochromator_slit_width
  • Added transmission_settings.detector_gain
  • Added transmission_settings.detector_integration_time
 src/nomad_measurements/transmission/schema.py
Dropped results/0/extinction_coefficient from the schema.
  • Removed obsolete quantity from schema
 src/nomad_measurements/transmission/schema.py
Added support for raw data files.
  • Introduced BrowserAnnotation with RawFileAdaptor
  • Added example raw data file
  • Added archive files for backcompatibility tests
 src/nomad_measurements/transmission/schema.py
tests/data/transmission/backcompatibility/KTF-D.Probe.Raw.asc
tests/data/transmission/backcompatibility/KTF-D.Probe.Raw.archive.json
tests/data/transmission/backcompatibility/MySample.archive.json
tests/data/transmission/backcompatibility/instrument.archive.json
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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]
sourcery-ai bot reviewed Jan 9, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ka-sarthak - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ka-sarthak ka-sarthak force-pushed the 151-integration-of-transmission-plugin branch from 2106282 to b6c26b0 Compare January 10, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Integration of transmission plugin
1 participant
@ka-sarthak