WIP: use jupytext into examples and documentation #3940
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
Changes: - leverage mystnb files - rework configurations - remove some extensions (might be reverted for the whole documentation to work)
SMoraisAnsys
force-pushed
the
doc/use_jupytext
branch
from
2eec9f4 to
c64e0c5
Compare
Set nbsphinx_pandoc in conf.py
Simplify syntax
Changes suffix to .sp.py Add epilog and prolog to notebooks
Changes suffix to .sp.py Add epilog and prolog to notebooks
PipKat
reviewed
Jan 22, 2024
| * Boundaries and excitations | ||
|
|
||
| When a boundary is attached to a face, the tool tries to match it with a | ||
| ``FaceByPosition`` on the same object name on the target design. If, for |
There was a problem hiding this comment.
What is ``FaceByPosition" as we should follow the code entity with a noun--such as attribute, property, object, or whatever.
PipKat
reviewed
Jan 22, 2024
| Maxwell 2D Electrostatic analysis | ||
| --------------------------------- | ||
| This example shows how you can use PyAEDT to create a Maxwell 2D electrostatic analysis. | ||
| It shows how to create the geometry, load material properties from an Excel file and |
There was a problem hiding this comment.
Suggested change
| It shows how to create the geometry, load material properties from an Excel file and | |
| It shows how to create the geometry, load material properties from an Excel file, and |
PipKat
reviewed
Jan 22, 2024
| --------------------------------- | ||
| This example shows how you can use PyAEDT to create a Maxwell 2D electrostatic analysis. | ||
| It shows how to create the geometry, load material properties from an Excel file and | ||
| set up the mesh settings. Moreover, it focuses on post-processing operations, in particular how to |
There was a problem hiding this comment.
Suggested change
| set up the mesh settings. Moreover, it focuses on post-processing operations, in particular how to | |
| set up the mesh settings. Moreover, it focuses on postprocessing operations, in particular how to |
PipKat
reviewed
Jan 22, 2024
Comment on lines
32
to
33
| # Download .xlsx file | ||
| # ~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Suggested change
| # Download .xlsx file | |
| # ~~~~~~~~~~~~~~~~~~~ | |
| # Download XLSX file | |
| # ~~~~~~~~~~~~~~~~~~ |
PipKat
reviewed
Jan 22, 2024
| ################################################################################# | ||
| # Download .xlsx file | ||
| # ~~~~~~~~~~~~~~~~~~~ | ||
| # Set local temporary folder to export the .xlsx file to. |
There was a problem hiding this comment.
Suggested change
| # Set local temporary folder to export the .xlsx file to. | |
| # Set local temporary folder to export the XLSX file to. |
PipKat
reviewed
Jan 22, 2024
| ################################################################################## | ||
| # Create object to access 2D modeler | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Create the object ``mod2D`` to access the 2D modeler easily. |
There was a problem hiding this comment.
Suggested change
| # Create the object ``mod2D`` to access the 2D modeler easily. | |
| # Create the ``mod2D`` object to access the 2D modeler easily. |
PipKat
reviewed
Jan 22, 2024
| ################################################################################## | ||
| # Read materials from .xslx file | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Read materials from .xslx file into and set into design. |
There was a problem hiding this comment.
Suggested change
| # Read materials from .xslx file into and set into design. | |
| # Read materials from the XSLX file into and set into design. |
Into the what? Or should it be: "# Read materials from the XSLX file and set into design."
PipKat
reviewed
Jan 22, 2024
| ################################################################################## | ||
| # Create design geometries | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Create rectangle and a circle and assign the material read from the .xlsx file. |
There was a problem hiding this comment.
Suggested change
| # Create rectangle and a circle and assign the material read from the .xlsx file. | |
| # Create a rectangle and a circle and assign the material read from the XLSX file. |
PipKat
reviewed
Jan 22, 2024
| ################################################################################## | ||
| # Define excitations | ||
| # ~~~~~~~~~~~~~~~~~~ | ||
| # Assign voltage excitations to rectangle and circle. |
There was a problem hiding this comment.
Suggested change
| # Assign voltage excitations to rectangle and circle. | |
| # Assign voltage excitations to the rectangle and circle. |
PipKat
reviewed
Jan 22, 2024
| # Evaluate the E Field tangential component | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Evaluate the E Field tangential component along the given polylines. | ||
| # Add these operations to the Named Expression list in Field Calculator. |
There was a problem hiding this comment.
Suggested change
| # Add these operations to the Named Expression list in Field Calculator. | |
| # Add these operations to the named expression list in the field calculator. |
PipKat
reviewed
Jan 22, 2024
Comment on lines
169
to
173
| # Create Field Line Traces Plot | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Create Field Line Traces Plot specifying as seeding faces | ||
| # the ground, the electrode and the region | ||
| # and as ``In surface objects`` only the region. |
There was a problem hiding this comment.
Suggested change
| # Create Field Line Traces Plot | |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| # Create Field Line Traces Plot specifying as seeding faces | |
| # the ground, the electrode and the region | |
| # and as ``In surface objects`` only the region. | |
| # Create a plot of field line traces | |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| # Create a plot of field line traces specifying as seeding faces | |
| # the ground, the electrode and the region | |
| # and as ``In surface objects`` only the region. |
This isn't clear to me. Are all three things listed seeding faces? Can this perhaps be rewritten more clearly?
PipKat
reviewed
Jan 22, 2024
Comment on lines
180
to
183
| # Update Field Line Traces Plot | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Update field line traces plot. | ||
| # Update seeding points number, line style and line width. |
There was a problem hiding this comment.
Suggested change
| # Update Field Line Traces Plot | |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| # Update field line traces plot. | |
| # Update seeding points number, line style and line width. | |
| # Update plot of field line traces | |
| # ~~~~~~~~~~~~~~~~~~~ | |
| # Update the plot of field line traces with new values for | |
| # the seeding points number, line style, and line width. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.