Skip to content

feat: post1 submodule (2/2) #4002

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

Open
wants to merge 4 commits into
base: feat/main_commands
Choose a base branch
from

Conversation

clatapie
Copy link
Contributor

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 post1 submodule, part 2. You can find part 1 PR at #4001.

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

Summary by Sourcery

Generate and integrate the post1 submodule as part one of the XML-to-Python conversion, providing a full suite of APDL postprocessing command wrappers and corresponding documentation.

New Features:

  • Introduce the post1 submodule with automated command wrappers for postprocessing (Animation, Controls, ElementTable, Fatigue, Load Case Calculations, Listing, SpecialPurpose, FailureCriteria).

Enhancements:

  • Refactor Post1Commands to inherit from new post1 classes instead of legacy implementations.

Documentation:

  • Add Sphinx documentation for all post1 commands under doc/source/mapdl_commands/post1.
  • Update ANSYS vocabulary acceptance list to accommodate new command terminology.

@clatapie clatapie self-assigned this Jun 11, 2025
@clatapie clatapie requested a review from a team as a code owner June 11, 2025 11:28
@clatapie clatapie requested review from germa89 and pyansys-ci-bot and removed request for a team June 11, 2025 11:28
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added the new feature Request or proposal for a new feature label Jun 11, 2025
Copy link
Contributor

sourcery-ai bot commented Jun 11, 2025

🧙 Sourcery is reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Jun 11, 2025
Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finishing review in #4003

@germa89
Copy link
Collaborator

germa89 commented Jun 12, 2025

@clatapie I am reviewing #4003, because it is easier...

image

compare to this PR:

image

The differences are explained in #4003

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants