docs: create self-contained apdl/pymapdl conversion example

[jgd10]

The examples don't contain any examples demonstrating conversion from APDL to PyMAPDL scripts. In this, I do just that.

This example does not download any files and uses a modified version of vm45 that has been hardcoded in. Otherwise, the example does save this file to a temp folder using tempfile, and then loads it again to do the conversion.

Description

New example in the Miscellaneous section.

Issue linked

There was no example demonstrating conversion from APDL scripts.

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• [-] I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• [-] I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[ansys-reviewer-bot]

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

@ansys-reviewer-bot review

[germa89]

Hi @jgd10

Thank you a lot for taking the time to publish this PR on PyMAPDL repo.
We always welcome contributions.

Overall, I like the idea. We were missing an example on the converter. I just added some small suggestions to it. Feel free to discard them if you do not see them appropriated or do not have the time.

[jgd10]

[like] James Derrick reacted to your message: ... **REDACTED**

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.29%. Comparing base (3801fe4) to head (ca41b9e).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3840      +/-   ##
==========================================
- Coverage   88.30%   88.29%   -0.02%     
==========================================
  Files         187      187              
  Lines       14819    14819              
==========================================
- Hits        13086    13084       -2     
- Misses       1733     1735       +2     

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[germa89]

@PipKat can you have a look at the writing of this example, to make sure it aligns with the PyMAPDL and PyAnsys examples??

[PipKat]

Hey there. I just finished a big review of PyAnsys Heart. I can take a look at this tomorrow if the PR is still open!

…

________________________________ From: German ***@***.***> Sent: Tuesday, April 15, 2025 9:08 AM To: ansys/pymapdl ***@***.***> Cc: Kathy Pippert ***@***.***>; Mention ***@***.***> Subject: Re: [ansys/pymapdl] docs: create self-contained apdl/pymapdl conversion example (PR #3840) [External Sender] @PipKat<https://github.com/PipKat> can you have a look at the writing of this example, to make sure it aligns with the PyMAPDL and PyAnsys examples?? — Reply to this email directly, view it on GitHub<#3840 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AUHQY23RHWQ7WGX4VJEMGOT2ZUAE7AVCNFSM6AAAAAB3DHFNKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQMBVGAYDEMJRGQ>. You are receiving this because you were mentioned.Message ID: ***@***.***> [https://avatars.githubusercontent.com/u/28149841?s=20&v=4]germa89 left a comment (ansys/pymapdl#3840)<#3840 (comment)> @PipKat<https://github.com/PipKat> can you have a look at the writing of this example, to make sure it aligns with the PyMAPDL and PyAnsys examples?? — Reply to this email directly, view it on GitHub<#3840 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AUHQY23RHWQ7WGX4VJEMGOT2ZUAE7AVCNFSM6AAAAAB3DHFNKCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQMBVGAYDEMJRGQ>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[germa89]

@PipKat I think there is no rush, you can do the review today or tomorrow.

Am I right @jgd10?

[PipKat]

Reviewed to style guide, with most changes related to using active voice and for proper formatting in the generated doc. The use of "method" versus "function" must be decided on and used consistently. Other comments are inline.

[jgd10]

Excellent! Thanks all!

[germa89]

Thank @jgd10 for taking the time! :)