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

I confirm that the TBFT error has been fixed.
This PR is ready for review whenever you will have time @germa89!

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.

After a quick look, it looks good to me.

However, I will add back the EDXXXX commands because PyMAPDL should be retrocompatible for as much versions as possible, that includes ANSYS 13.0 through the console interface.
Any person running any an Ansys version compatible with ED commands, should be able to run them using PyMAPDL.
Also please checks the

Parameters
----------
type_ : str
Type of entity used to define the circular arc. The meaning of ``VAL1`` through ``VAL4`` will vary depending on ``Type``. If ``Type`` = P, graphical picking is enabled and all remaining command fields are ignored (valid only in the GUI).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Very long line?

Comment on lines +227 to +233
.. warning::

This function contains specificities regarding the argument definitions.
Please refer to the `command documentation <https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_KCENTER.html>`_
for further explanations.

.. _KCENTER_notes:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Shouldn't be the warning after the label?

three locations on a line. Note that for method c, if a circular line is specified by ``VAL1``,
``VAL2`` through ``VAL4`` are not needed.

.. figure::../../../images/_commands/gKCEN1.svg
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are the images being introduced/added?

4
"""
command = f"KCENTER,{type_},{val1},{val2},{val3},{val4},{kpnew}"
return parse.parse_kpoint(self.run(command, **kwargs))
Copy link
Collaborator

Choose a reason for hiding this comment

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

this parse module should be replaced by a wrapper in the _MapdlCore class. Eventually, I will do it.

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