Skip to content

First Learning Roadmap inclusion (PyMechanical)#307

Open
jgd10 wants to merge 4 commits intomainfrom
fix/roadmaps
Open

First Learning Roadmap inclusion (PyMechanical)#307
jgd10 wants to merge 4 commits intomainfrom
fix/roadmaps

Conversation

@jgd10
Copy link
Contributor

@jgd10 jgd10 commented Feb 6, 2026

apparently this includes some minor usecase fixes as well. They're small so I'd like to leave them in but otherwise this PR is for the creation of the first of the learning roadmaps

@jgd10 jgd10 requested review from AnsMelanie and PipKat February 6, 2026 15:54

## Learning Roadmaps

* [PyMechanical Roadmap](<https://developer.ansys.com/docs/ansys-developer-product-guide/learning_roadmaps.md#ip-pymechanical>)
Copy link
Member

Choose a reason for hiding this comment

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

Is it expected that this link returns a 404 error currently?

href: index.md
- name: Glossary
href: glossary.md
- name: Learning Roadmaps
Copy link
Member

Choose a reason for hiding this comment

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

Should we be using sentence case?

If you are interested in getting started with PyAnsys or any of Ansys' Python tools, Ansys provides the open-source Ansys Python Manager for assistance with installing Python and creating virtual environments.

* Read more about the tool in this article, [Ansys Python Manager](https://developer.ansys.com/ansys-python-manager).
* Access the docs, [Ansys Python Manager documentation](https://installer.docs.pyansys.com/).
Copy link
Member

@PipKat PipKat Feb 26, 2026

Choose a reason for hiding this comment

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

Suggested change
* Access the Ansys Python Manager documentation](https://installer.docs.pyansys.com/version/stable/).

This tool's documentation definitely needs to be overhauled, and I have added this task to my to-do list. Its documentation was never reviewed for public release. ACE developed and released this tool.


* Read more about the tool in this article, [Ansys Python Manager](https://developer.ansys.com/ansys-python-manager).
* Access the docs, [Ansys Python Manager documentation](https://installer.docs.pyansys.com/).
* Download the latest release, [Ansys Python Manager releases](https://github.com/ansys/python-installer-qt-gui/releases).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Download the latest release from this repository's [Releases](https://github.com/ansys/python-installer-qt-gui/releases) page.


## All Products

* [AEDT](<https://developer.ansys.com/docs/ansys-developer-product-guide/electronics_and_semiconductors.md#ip-aedt>)
Copy link
Member

@PipKat PipKat Feb 26, 2026

Choose a reason for hiding this comment

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

Suggested change
* [Electronics and Semiconductors](<https://developer.ansys.com/docs/ansys-developer-product-guide/electronics_and_semiconductors.md#ip-aedt>)

AEDT isn't the name of the page, so I'd suggest we use the page name so the user knows they ended up in the correct location. It seems that the same logic should be applied by replacing the next three entries with one Autonomous Vehicle Simulation link.

* [AVxcelerate Headlamp](<https://developer.ansys.com/docs/ansys-developer-product-guide/Autonomous_Vehicle_Simulation.md#ip-avxcelerate-headlamp>)
* [AVxcelerate Sensors](<https://developer.ansys.com/docs/ansys-developer-product-guide/Autonomous_Vehicle_Simulation.md#ip-avxcelerate-sensors>)
* [Access on Microsoft Azure](<https://developer.ansys.com/docs/ansys-developer-product-guide/Cloud.md#ip-access-on-microsoft-azure>)
* [All Products](<https://developer.ansys.com/docs/ansys-developer-product-guide/index.md#ip-all-products>)
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this link be the first one--since it takes them to the listing of all products?

* [AVxcelerate Sensors](<https://developer.ansys.com/docs/ansys-developer-product-guide/Autonomous_Vehicle_Simulation.md#ip-avxcelerate-sensors>)
* [Access on Microsoft Azure](<https://developer.ansys.com/docs/ansys-developer-product-guide/Cloud.md#ip-access-on-microsoft-azure>)
* [All Products](<https://developer.ansys.com/docs/ansys-developer-product-guide/index.md#ip-all-products>)
* [Ansys Additive Suite](<https://developer.ansys.com/docs/ansys-developer-product-guide/Ansys_Additive_Solutions.md#ip-ansys-additive-suite>)
Copy link
Member

@PipKat PipKat Feb 26, 2026

Choose a reason for hiding this comment

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

Suggested change
* [Ansys Additive Solutions](<https://developer.ansys.com/docs/ansys-developer-product-guide/Ansys_Additive_Solutions.md#ip-ansys-additive-suite>)

I think we have to decide whether we want to match the title of the page we are being taken to--or to the next level down. I vote for the first, because some pages (like the Electronics and Semiconductors one and the Autonomous Vehicle Simulation one have multiple products discussed on them.

  • Of course, then we get to the next several links which are on the Miscellaneous page. I see there is no clear or best way to do this. I guess whatever you decide is OK! However, the big problem is that say a user clicks the Ansys Notebook or Ansys Chemkin entry, they are taken to the top of the Miscellaneous page, which is confusing! The link doesn't seem to respect the destination token (#ip-chemkin).


## Ansys Mechanical and MAPDL

The Ansys Mechanical product consists of two aspects: Mechanical and Mechanical APDL (MAPDL). MAPDL further consists of two constituent parts: the user interface that lets you call and run APDL code, and APDL itself. APDL stands for "Ansys Parametric Design Language."
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The Ansys Mechanical product consists of two modules: Mechanical and Mechanical APDL (MAPDL). MAPDL further consists of two constituent parts: the user interface that lets you call and run APDL code and APDL itself. APDL stands for "Ansys Parametric Design Language."


The Ansys Mechanical product consists of two aspects: Mechanical and Mechanical APDL (MAPDL). MAPDL further consists of two constituent parts: the user interface that lets you call and run APDL code, and APDL itself. APDL stands for "Ansys Parametric Design Language."

Ansys Mechanical and MAPDL are essentially two sides of the same coin, being two ways to access the same solver. There are four principal developer tools associated with them plus a fifth that's only available as part of the Mechanical Premium and Enterprise products.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Ansys Mechanical and MAPDL are essentially two sides of the same coin, being two ways to access the same solver. There are four principal developer tools associated with them, plus a fifth that's only available as part of the Mechanical Premium and Enterprise products.


#### Learning Roadmaps

* [PyMechanical Roadmap](<https://developer.ansys.com/docs/ansys-developer-product-guide/learning_roadmaps.md#ip-pymechanical>)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* [PyMechanical Roadmap](<https://developer.ansys.com/docs/ansys-developer-product-guide/learning_roadmaps.md#ip-pymechanical>)
* [PyMechanical roadmap](<https://developer.ansys.com/docs/ansys-developer-product-guide/learning_roadmaps.md#ip-pymechanical>)

I am assuming we are using title case. This link also returns a 404 error.


### Non-Ansys Mechanical and MAPDL training material

* Using Ansys Scripting with pyMAPDL, pyDPF-Post, and More
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Using Ansys Scripting with pyMAPDL, pyDPF-Post, and More
* Using Ansys Scripting with PyMAPDL, PyDPF-Post, and more

Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

@jgd10 I understand your objective here and consider it heroic. However, I must admit that these long lists of links exhaust me. Are we sure we don't want to promote to the user how he or she can use Ansys ChatGPT to gather this information? It seems educating a user on how to gather the needed information on the fly is way easier than creating and maintaining these roadmaps!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants