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

📖 DOCS: Multiphysics further docs and minor bug fixes #1462

Draft
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

daquinteroflex
Copy link
Collaborator

@daquinteroflex daquinteroflex commented Feb 12, 2024

  • 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

Copy link
Collaborator

@tylerflex tylerflex left a 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:
Copy link
Collaborator

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:
Copy link
Collaborator

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?

@daquinteroflex
Copy link
Collaborator Author

Haha sorry this is still WIP! I think the PR that was ready for review is #1451

@tylerflex
Copy link
Collaborator

oh whoops :D sorry

@daquinteroflex daquinteroflex changed the base branch from pre/2.6 to develop March 13, 2024 11:28
@daquinteroflex daquinteroflex changed the title FEAT: Multiphysics further docs improvements 🔥 ⚡ 📖 DOCS: Multiphysics further docs improvements 🔥 ⚡ Apr 10, 2024
@daquinteroflex daquinteroflex changed the title 📖 DOCS: Multiphysics further docs improvements 🔥 ⚡ 📖 DOCS: Multiphysics further docs and minor bug fixes Apr 10, 2024
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