docs: example on battery pack #4596
Conversation
MohammedAnsys
requested review from
hpohekar,
mayankansys,
mkundu1,
prmukherj and
seanpearsonuk
as code owners
github-actions
bot
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR adds two new PyFluent example workflows demonstrating electrochemical simulations: a PEM electrolyzer model and a 1P3S battery pack simulation. Both examples follow the new API implementation guidelines and provide end-to-end workflows with visualization.
- Introduces
Electrolysis_Modeling_workflow.pydemonstrating PEM electrolyzer simulation with Butler-Volmer kinetics - Adds
Battery_Pack.pyshowing NTGK battery pack modeling with thermal management - Updates documentation configuration and CI workflow to include the new examples
Reviewed Changes
Copilot reviewed 4 out of 16 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| examples/00-fluent/Electrolysis_Modeling_workflow.py | New example implementing PEM electrolysis simulation with multiphase flow and electrochemical reactions |
| examples/00-fluent/Battery_Pack.py | New example demonstrating 1P3S battery pack simulation with NTGK model and dual-path conductivity |
| doc/source/conf.py | Added new example filenames to the Sphinx gallery configuration pattern |
| .github/workflows/execute-examples-weekly.yml | Added execution steps for both new examples in the weekly CI workflow |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove Electrolysis_Modeling_workflow.py - Remove electrolysis related PNG images - Keep only battery pack example files
MohammedAnsys
force-pushed
the
docs/exaample_on_battery_pack
branch
from
200f190 to
5ff8c9f
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 11 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 12 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 12 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@MohammedAnsys, please re-run the pre-commit from your end to fix the code styling issues. |
- Reformat dictionary for better readability - Consolidate monitor plotting code - Improve code consistency per Black style guidelines
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 13 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 13 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Done! re-ran pre-commit and fixed all styling issues. |
End-to-end PyFluent workflow on battery pack
ANSYS Fluent User's Guide, ANSYS, Inc.
Simulating a 1P3S Battery Pack Using the Battery Model
The example tries to follow the provided guidelines with #4378 and uses the new API implementation.
Thanks.