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

Fix luminescent #525

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

Fix luminescent #525

wants to merge 8 commits into from

Conversation

joamatab
Copy link
Contributor

@joamatab joamatab commented Dec 30, 2024

Summary by Sourcery

Update installation instructions, move material definitions, and update waveguide bend examples.

New Features:

  • Added support for 2.5D simulations using "approx_2D_mode".

Enhancements:

  • Updated the file workflow description.

Tests:

  • Updated waveguide bend tests to use new API and include 2.5D simulations.

Copy link
Contributor

sourcery-ai bot commented Dec 30, 2024

Reviewer's Guide by Sourcery

This pull request updates the luminescent notebook with some improvements to the text, installation instructions, and code examples. It also updates the version number to v0.3-beta.

Sequence diagram for updated simulation workflow

sequenceDiagram
    participant User
    participant Python as Python Frontend
    participant Julia as Julia Backend
    participant FDTD as FDTD Solver

    User->>Python: Create component with gdsfactory
    Python->>Julia: make_pic_sim_prob()
    Julia->>FDTD: Configure simulation
    FDTD-->>Julia: Simulation setup complete
    Julia->>FDTD: solve()
    FDTD-->>Julia: Simulation results
    Julia-->>Python: Return results
    Python-->>User: Display results via load_res()
Loading

File-Level Changes

Change Details Files
Updated the introductory text and added a link to the Colab notebook.
  • Updated version number to v0.3-beta.
  • Added a maintenance message.
  • Added a link to the Colab notebook for users who can't see output figures or table of contents.
  • Removed beta version from v0.3
notebooks/luminescent.ipynb
Added a section on materials.
  • Added a new section explaining the materials used in the simulations.
  • Explained that dispersive, anisotropic, and nonlinear materials are not simulated by default but can be implemented upon request.
  • Updated the geometry layout section to remove the material information that is now in its own section
notebooks/luminescent.ipynb
Updated the installation instructions.
  • Clarified the installation instructions for Windows users.
  • Added instructions for installing Julia on Linux.
  • Added instructions for installing the FDTD package.
  • Removed the old installation instructions.
  • Added shell commands for pip install and Julia install
notebooks/luminescent.ipynb
Updated the file workflow section.
  • Simplified the explanation of the file workflow.
  • Removed specific details about the working directory and run folders.
  • Removed references to load_solution, write_sparams, and gcell_problem.
  • Added references to load_res, and finetune
notebooks/luminescent.ipynb
Updated the waveguide bend tutorial.
  • Added import os
  • Changed name to path.
  • Added dtype="float32".
  • Changed nres from 40 to 30.
  • Updated the code to use make_pic_sim_prob and solve instead of write_sparams.
  • Updated the code to use load_res instead of load_solution.
  • Updated the expected loss value.
  • Added a 2.5D approximation section.
  • Updated the 2.5D approximation section to use approx_2D_mode="TE" instead of N=2.
  • Updated the 1.5um radius example to use the new API calls.
  • Updated the wavelength range example to use the new API calls
notebooks/luminescent.ipynb
Updated the customizing materials, layers, and modes section.
  • Removed the code example.
  • Commented out the code example.
  • Removed materials from the default parameters
notebooks/luminescent.ipynb
Updated the mode converter tutorial.
  • Added recommended RAM.
  • Changed name to path.
  • Updated the code to use make_pic_inv_prob, solve, and load_res.
  • Added N=2 to gcell_problem.
  • Added stoploss=0.05 to gcell_problem.
  • Added approx_2D_mode="TE" to make_pic_inv_prob.
  • Removed finetune example.
  • Updated the code to load the solution using load_res
notebooks/luminescent.ipynb
Updated the 1x2 splitter MMI tutorial.
  • Added import os
  • Changed name to path.
  • Updated the code to use make_pic_inv_prob, solve, and load_res.
  • Added approx_2D_mode="TE" to make_pic_inv_prob
notebooks/luminescent.ipynb
Updated the 1x4 splitter MMI tutorial.
  • Removed the empty code cell.
  • Commented out the finetune and load_solution calls.
  • Changed load_solution to load_res
notebooks/luminescent.ipynb
Updated the wavelength domain demultiplexer tutorial.
  • Reduced RAM requirement from 32G to 20G.
  • Changed name to path.
  • Updated the code to use make_pic_inv_prob, solve, and load_res.
  • Commented out the entire code example
notebooks/luminescent.ipynb
Updated the symmetric crossing tutorial.
  • Added from pprint import pprint.
  • Changed name to path.
  • Updated the code to use make_pic_inv_prob, solve, and load_res.
  • Commented out the entire code example
notebooks/luminescent.ipynb

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

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.

@github-actions github-actions bot added the bug Something isn't working label Dec 30, 2024
@joamatab
Copy link
Contributor Author

@paulxshen

this PR has more fixes but still doesn't work

@paulxshen
Copy link
Contributor

@joamatab Thanks I'll move the shell install script from notebook to proper place. BTW does your test server have a GPU?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants