Example/busbar joule heating #436
Conversation
There was a problem hiding this comment.
@gmalinve Ready for review.
There was a problem hiding this comment.
@gchaturve: Great to have you contributing to the examples! Could you please take a look at the template we've tried to use for the examples? We still have not updated all the examples to match the template. That is an important task though.
The numbering of sections seems like a good idea, but the overall workflow should use at least H2 and H3 levels as was shown in the template: 1. Setup, 2. Solve, 3. Evaluate results.
There was a problem hiding this comment.
Thankyou @Devin-Crawford I'll review the template and align my example with the required H2/H3 section levels (Setup, Solve and Evaluate Results)
I'll update it shortly to ensure it matches the structure and conventions shown in the template
gchaturve
requested review from
SMoraisAnsys,
Samuelopez-ansys,
gmalinve and
maxcapodi78
as code owners
| @@ -0,0 +1,343 @@ | |||
| # %% [markdown] | |||
There was a problem hiding this comment.
Why are you adding the # %% [markdown] label everywhere ? If it's required for a specific reason, can you let me know why ? We're currently relying on jupytext and notebook related packages to handle the documentation.
There was a problem hiding this comment.
I have added these %% [markdown] blocks so that scripts can be opened and navigated seamlessly in VS Code/ Pycharm interactive mode. This is for ensuring both code cells & documentation cells are preserved in a notebook-like -structure while using the IDE (without requiring a full .ipynb workflow)
Purpose:
- To make example easier to run step by step in IDE's that support cell excecution
- To keep the documentation inlingned and synchronized with the code (similar to jupyter)
- To maintain consistency across different environments (may prefer VS Code over jupyter)
There was a problem hiding this comment.
@gchaturve : You can also run/edit in Jupyter Lab using Jupytext. That was the idea behind the formatting we've used. The files also have to be parsed and rendered as HTML so the %% may cause problems with the CI/CD. I'll defer to @SMoraisAnsys.
gchaturve
requested review from
Devin-Crawford,
jvela018 and
nunesanderson
as code owners
- Changed cell markers from # %% to # + and # - - Updated tmpdir to temp_folder for consistency - Reorganized sections to match template structure - Added temp_folder.cleanup() at end - Preserved all functionality and analysis content
|
Hi @gchaturve , Thanks for taking care of the comments. On top of aligning your example with the template, I would suggest also two other things:
Giulia |
gchaturve
force-pushed
the
example/busbar_joule_heating
branch
from
16574da to
36222a8
Compare
Description
Created a multi terminal busbar joule heating example under eddy current solution type.
Checklist
Please complete the following checklist before submitting your pull request: