Skip to content

add mzi_heater with pads #4

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

Merged
merged 1 commit into from
Mar 14, 2025
Merged

add mzi_heater with pads #4

merged 1 commit into from
Mar 14, 2025

Conversation

joamatab
Copy link
Contributor

@joamatab joamatab commented Mar 14, 2025

Summary by Sourcery

New Features:

  • Introduces a new component, mzi_heater_with_pads, that combines an MZI heater with electrical pads for connection.

Copy link

sourcery-ai bot commented Mar 14, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new component, mzi_heater_with_pads, by creating new SCM and PIC YAML files. It also updates the transforms in the existing mzi_heater.scm.yml file.

Class diagram for mzi_heater_with_pads component

classDiagram
  class mzi_heater_with_pads {
    +transforms
    +component_ports
    +instances
    +connections
    +routes
    +nets
    +ports
    +placements
  }

  class bend_euler_sc {
    +o2: n
    +o1: w
  }

  class coupler_sc {
    +o3: e
    +o4: e
    +o1: w
    +o2: w
  }

  class straight_heater_metal_sc {
    +o2: e
    +r_e3: e
    +o1: w
    +l_e1: w
    +length: float
  }

  class pad {
    +e2: n
    +e3: e
    +pad: e
    +e4: s
    +e1: w
  }

  mzi_heater_with_pads -- bend_euler_sc : has b1, b2, b3, b4
  mzi_heater_with_pads -- coupler_sc : has c1, c2
  mzi_heater_with_pads -- straight_heater_metal_sc : has h
  mzi_heater_with_pads -- pad : has p1, p2

  note for mzi_heater_with_pads "Represents the overall structure of the MZI heater with pads component."
  note for bend_euler_sc "Represents a bend in the waveguide."
  note for coupler_sc "Represents a coupler component."
  note for straight_heater_metal_sc "Represents a straight heater with metal."
  note for pad "Represents a pad component."
Loading

File-Level Changes

Change Details Files
Introduces a new component, mzi_heater_with_pads, which combines an MZI heater with electrical pads for testing.
  • Creates a new SCM YAML file defining the transforms for the component.
  • Creates a new PIC YAML file defining the component's structure, including instances of basic building blocks (bends, couplers, heater, pads), their connections, and routing.
mycspdk/mzi_heater_with_pads.scm.yml
mycspdk/mzi_heater_with_pads.pic.yml
Updates the transforms in mzi_heater.scm.yml.
  • Reorders and renames the transform keys.
  • Adjusts the translation values for each transform.
  • Updates the z-coordinate of the translation for the 'e1' and 'e2' transforms.
mycspdk/mzi_heater.scm.yml

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

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

@joamatab joamatab merged commit 492d01b into main Mar 14, 2025
@joamatab joamatab deleted the add_mzi_with_pads branch March 28, 2025 03: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.

1 participant