Skip to content

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 first part of the prep7 submodule integration.

You can check the mapdl-cmd-conv documentation to have a look at the output of each methods.

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_prep7 branch. The latter will gather all the parts of the submodule prior to be merged to the main branch.

Checklist

@clatapie clatapie requested a review from germa89 October 15, 2025 16:36
@clatapie clatapie self-assigned this Oct 15, 2025
@clatapie clatapie requested a review from a team as a code owner October 15, 2025 16:36
@clatapie clatapie requested review from pyansys-ci-bot and removed request for a team October 15, 2025 16:36
@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Oct 15, 2025
@clatapie
Copy link
Contributor Author

clatapie commented Oct 15, 2025

The EDASMP command has been removed from MAPDL commands as it doesn't appear on the official documentation since (at least) R23.2.

I am removing the failing tests and mapdl_extended.py file accordingly.

EDIT: this command has been deprecated in R19.1

@mikerife
Copy link

@clatapie The ability to pre/post process a explicit dynamics model for the ls-dyna solver was removed from mapdl in v19.1. So most of the commands that start with 'ED' should not exist anymore in mapdl....anyone wanting to use those could use PyDyna or PyMechanical (which supports ls-dyna solver).

@clatapie
Copy link
Contributor Author

Thank you for your comment @mikerife!
Indeed, a lot more commands than the EDASMP command were concerned by this. I removed all of them accordingly

@clatapie
Copy link
Contributor Author

The TBFT function is not correctly parsed.

# How it should render:
def tbft(self, oper, matid, option1, option2, option3, option4, option5, option6, option7, option10, **kwards):

# How it currently renders:
def tbft(self, **kwards):

I am investigating it.

@clatapie
Copy link
Contributor Author

This error enables me to catch a broader one: 5 functions (including TBFT) `were not showing arguments as they should have. It is due to the fact that there have specific formats.

The TBFT error was fixed with ansys/pyconverter-xml2py@ccbb8ca and the broader one with ansys/pyconverter-xml2py@73cab27

@clatapie
Copy link
Contributor Author

ExplicitDynamics class has been reintroduced as asked.

The PR is ready to be reviewed and merged on my side.

@germa89 germa89 requested a review from Copilot November 19, 2025 14:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR continues the PyConverter-XML2Py integration to automate PyMAPDL command documentation, focusing on part 2 of the prep7 submodule. The changes involve migrating multiple command classes from the preproc package to the prep7 package with updated documentation formats and type hints.

Key Changes:

  • Migrated 9 command classes (database, element_type, elements, explicit_dynamics, hard_points, keypoints, lines, materials, morphing) from preproc to prep7
  • Updated class inheritance in Prep7Commands and PreprocessorCommands
  • Modernized documentation with Sphinx directives and restructured RST files

Reviewed Changes

Copilot reviewed 32 out of 35 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/ansys/mapdl/core/commands.py Updated Prep7Commands to inherit from migrated classes, removed corresponding classes from PreprocessorCommands
src/ansys/mapdl/core/_commands/preproc/*.py Deleted 9 command class files from preproc package
src/ansys/mapdl/core/_commands/prep7/*.py Added 9 command class files to prep7 with updated type hints and documentation
src/ansys/mapdl/core/_commands/preproc/__init__.py Removed imports for migrated classes
src/ansys/mapdl/core/_commands/prep7/__init__.py Added imports for migrated classes
doc/source/mapdl_commands/prep7/*.rst Updated documentation structure with new Sphinx references and class paths
doc/changelog.d/4262.added.md Added changelog entry

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

LGTM!

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) labels Nov 20, 2025
Comment on lines +241 to +244
.. only:: html
.. figure:: ../../../images/_commands/gKCEN1.svg
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is auto-generated. If this is the only way to fix it I will need to make a broader fix all over the docstrings.

Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

This is really great to see the part 2. For the svg issue, I am guessing you will create a different PR.

@clatapie
Copy link
Contributor Author

Sure I can do it this way. I will merge this PR and add the changes in part 3.

@clatapie clatapie merged commit 6c4a1be into feat/main_prep7 Nov 21, 2025
43 of 45 checks passed
@clatapie clatapie deleted the feat/prep7_submodule_2 branch November 21, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD Related with CICD, Github Actions, etc documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc) new feature Request or proposal for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants