feat: post26 submodule
#3892
Open
feat: post26 submodule
#3892
Conversation
This file contains hidden or 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
clatapie
requested review from
germa89 and
pyansys-ci-bot
and removed request for
a team
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
github-actions
bot
added
documentation
|
@sourcery-ai review |
Reviewer's GuideThis pull request introduces the Class Diagram for Post26Commands and its New Base ClassesclassDiagram
direction LR
class Post26Commands {
+pass
}
note for Post26Commands "Inherits from new auto-generated classes in the 'post26' submodule,\nreplacing the former 'post26_' submodule and its classes."
class P26_InternalSetUp {
"<<ansys.mapdl.core._commands.post26._set_up.SetUp>>"
+gapf()
}
class P26_Controls {
"<<ansys.mapdl.core._commands.post26.controls.Controls>>"
+...
}
class P26_Display {
"<<ansys.mapdl.core._commands.post26.display.Display>>"
+keep()
+plvar()
+pltime()
+plcplx()
+xvar()
+spread()
}
class P26_Listing {
"<<ansys.mapdl.core._commands.post26.listing.Listing>>"
+extrem()
+prtime()
+prcplx()
+prvar()
+lines()
+nprint()
}
class P26_Operations {
"<<ansys.mapdl.core._commands.post26.operations.Operations>>"
+exp()
+prod()
+large()
+nlog()
+realvar()
+int1()
+imagin()
+clog()
+conjug()
+atan()
+add()
+abs()
+deriv()
+quot()
+sqrt()
+small()
+filldata()
}
class P26_SetUp {
"<<ansys.mapdl.core._commands.post26.set_up.SetUp>>"
+enersol()
+esol()
+gssol()
+timerange()
+vardel()
+varnam()
+nsol()
+numvar()
+nstore()
+rforce()
+rgb()
+cisol()
+ansol()
+data()
+jsol()
+store()
+solu()
}
class P26_SpecialPurpose {
"<<ansys.mapdl.core._commands.post26.special_purpose.SpecialPurpose>>"
+...
}
class P26_Status {
"<<ansys.mapdl.core._commands.post26.status.Status>>"
+...
}
Post26Commands --|> P26_InternalSetUp
Post26Commands --|> P26_Controls
Post26Commands --|> P26_Display
Post26Commands --|> P26_Listing
Post26Commands --|> P26_Operations
Post26Commands --|> P26_SetUp
Post26Commands --|> P26_SpecialPurpose
Post26Commands --|> P26_Status
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @clatapie - I've reviewed your changes - here's some feedback:
Post26Commandsinherits from bothpost26._set_up.SetUpandpost26.set_up.SetUp; please clarify if both are intended.- The new structure includes both
_set_up.pyandset_up.pyfiles within thepost26module; consider consolidating if appropriate.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
germa89
requested changes
May 6, 2025
There was a problem hiding this comment.
I guess the biggest problems I see are:
- Missing status commands
- Not using footnotes for tables.
- Codacy: Redefinition of
idfunction insrc/ansys/mapdl/core/_commands/post26/set_up.py:1040 - Missing third rows in some tables.
- Missing italics?
The bot raised an interesting comment about the _set_up.py and set_up.py: #3892 (review)
Does it have a point?
Comment on lines
-14
to
+19
| Mapdl.define | ||
| Mapdl.operate | ||
| Mapdl.plotting | ||
| Mapdl.print | ||
| Status.operate | ||
| Status.plotting |
There was a problem hiding this comment.
Maybe we are missing some commands?
There was a problem hiding this comment.
Some functions have multiple "parents". This is the case for define and print. They both appear in POST1 and POST26:
For now, the first parent appearing in the parent section is the one where the function will be assigned. Thus, print and define are in post1 submodule.
Are you fine with this approach?
Comment on lines
135
to
136
| variable is filled. The number of loops may be controlled with the `\*VLEN | ||
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ :ref:`vlen` |
There was a problem hiding this comment.
Shall we separate both command versions with a /??
Suggested change
| variable is filled. The number of loops may be controlled with the `\*VLEN | |
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ :ref:`vlen` | |
| variable is filled. The number of loops may be controlled with the `\*VLEN | |
| <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en/ans_cmd/Hlp_C_VLEN.html#>`_ / :ref:`vlen` |
This was referenced May 26, 2025
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.
Description
This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.
This PR focus on the
post26submodule.You can check the mapdl-cmd-conv documentation to have a look at the output of each submodules.
Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.
Issue linked
This PR is meant to be merged within the feat/main_commands branch. The latter will gather all the submodule changes, one by one, prior to be merged to the main branch.
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)Summary by Sourcery
Implement the
post26submodule for PyMAPDL, following the PyConverter-XML2Py integration plan to automate documentation generationNew Features:
post26submodule with comprehensive command implementationsChores:
post26_directory