-
Notifications
You must be signed in to change notification settings - Fork 44
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
📖 DOCS: Multiphysics further docs and minor bug fixes #1462
base: develop
Are you sure you want to change the base?
Conversation
daquinteroflex
commented
Feb 12, 2024
•
edited
Loading
edited
- Improvements to HEAT API based on notebook examples
- Nice time-varying GIF showing dynamic coupled HEAT and FDTD simulations on the front page, maybe other representative nice images
- Improved docs to the plugins from the README
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! just a few minor corrections.
@@ -3,6 +3,12 @@ | |||
Material Thermal Specification | |||
------------------------------- | |||
|
|||
To create simulation setups that can be used in different solvers we need to create material specifications that contain all relevant information for each of the solvers. Specifically, when performing coupled thermal and optic simulations, each material definition will contain up to three different characteristic: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- comma after "used in different solvers".
- pluralize last word ("characteristics")
- in 1-2, comma before "such as"
- 1, 3: optic -> optical?
@@ -226,6 +234,13 @@ def plot_heat_conductivity( | |||
) -> Ax: | |||
"""Plot each of simulation's components on a plane defined by one nonzero x,y,z coordinate. | |||
|
|||
Visualization of [HeatSimulation](./tidy3d.HeatSimulation.html) object displays: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should these be RST links? seem like markdown format?
Haha sorry this is still WIP! I think the PR that was ready for review is #1451 |
oh whoops :D sorry |
cffda30
to
330f587
Compare
7365746
to
9cd63c5
Compare