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

remove dagster plugin #550

Merged
merged 1 commit into from
Feb 19, 2025
Merged

remove dagster plugin #550

merged 1 commit into from
Feb 19, 2025

Conversation

joamatab
Copy link
Contributor

@joamatab joamatab commented Feb 19, 2025

Summary by Sourcery

This pull request removes the Dagster plugin and improves documentation for Lumerical Interconnect functions.

Enhancements:

  • Improve documentation for add_interconnect_element and run_wavelength_sweep functions by clarifying argument descriptions.

Chores:

  • Remove Dagster plugin files.

Copy link
Contributor

sourcery-ai bot commented Feb 19, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Lumerical Interconnect integration, enhancing simulation control and component layout. It also removes the Dagster plugin.

Updated class diagram for Interconnect integration

classDiagram
    class add_interconnect_element {
        +session: Interconnect session
        +label: str
        +model: str
        +loc: tuple
        +flip_vert: bool
        +flip_horiz: bool
        +rotation: float
        +simulation_props: dict
    }

    class send_to_interconnect {
        +component: Component
        +session: Interconnect session
        +ports_in: dict
        +ports_out: dict
        +placements: list
        +simulation_settings: dict
        +drop_port_prefix: str
        +component_distance_scaling_x: float
        +component_distance_scaling_y: float
        +setup_mc: bool
        +exclude_electrical: bool
        +settings: dict
    }

    class run_wavelength_sweep {
        +component: Component
        +session: Interconnect session
        +setup_simulation: bool
        +is_top_level: bool
        +ports_in: dict
        +ports_out: dict
        +mode: str
        +wavelength_range: tuple
        +n_points: int
        +results: list
        +extra_ona_props: dict
        +kwargs: dict
    }

    note for add_interconnect_element "Updated simulation_props"
    note for send_to_interconnect "Added component_distance_scaling_x, component_distance_scaling_y, setup_mc, exclude_electrical, settings"
    note for run_wavelength_sweep "Added is_top_level and mode"
Loading

File-Level Changes

Change Details Files
Refactors the add_interconnect_element function to use simulation_props instead of individual arguments for simulation properties.
  • Replaces individual arguments like flip_vert, flip_horiz, and rotation with a single simulation_props argument.
  • Updates the function documentation to reflect the change in arguments.
gplugins/lumerical/interconnect.py
Enhances the send_to_interconnect function with additional parameters for simulation control and layout scaling.
  • Adds ports_in and ports_out parameters for specifying input and output ports.
  • Introduces component_distance_scaling_x and component_distance_scaling_y for independent scaling of component distances.
  • Adds setup_mc and exclude_electrical parameters for Monte Carlo simulation setup and electrical component exclusion.
  • Includes a settings parameter for additional simulation settings.
gplugins/lumerical/interconnect.py
Updates the run_wavelength_sweep function to include additional arguments and improve documentation.
  • Adds is_top_level and mode arguments for specifying top-level components and simulation modes.
  • Updates the function documentation to provide more detailed information about the arguments.
gplugins/lumerical/interconnect.py
Removes run_wavelength_sweep from the __all__ list in gplugins/lumerical/__init__.py.
  • Removes run_wavelength_sweep from the list of exported symbols.
gplugins/lumerical/__init__.py
Removes the Dagster plugin files.
  • Deletes gplugins/dagster/Makefile.
  • Deletes gplugins/dagster/workflow.py.
gplugins/dagster/Makefile
gplugins/dagster/workflow.py

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link
Contributor

@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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

Label error. Requires at least 1 of: breaking, bug, github_actions, documentation, dependencies, enhancement, feature, maintenance, security. Found:

@joamatab joamatab merged commit 7033e1f into main Feb 19, 2025
10 of 17 checks passed
@joamatab joamatab deleted the remove_dagster branch February 19, 2025 01:21
@joamatab joamatab changed the title reomve dagster plugin remove dagster plugin Feb 20, 2025
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