ansys-mapdl-core 0.72.1

A Python client library for Ansys MAPDL.

Overview

The PyMAPDL project supports Pythonic access to MAPDL to be able to communicate with the MAPDL process directly from Python. The latest ansys-mapdl-core package enables a more comprehensive interface with MAPDL and supports:

• All the features of the original module (for example, Pythonic commands and interactive sessions).

• Remote connections to MAPDL from anywhere via gRPC.

• Direct access to MAPDL arrays, meshes, and geometry as Python objects.

• Low-level access to the MAPDL solver through APDL math in a SciPy- like interface.

Here's a quick demo of PyMAPDL within Visual Studio Code:

PyMAPDL works within Jupyter Notebooks, the standard Python console, or in batch mode on Windows, Linux, and even macOS.

Documentation and issues

Documentation for the latest stable release of PyMAPDL is hosted at PyMAPDL Documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

You can also download the PyMAPDL cheat sheet. This one-page reference provides syntax rules and commands for using PyMAPDL.

For troubleshooting, visit Troubleshooting PyMAPDL

On the PyMAPDL Issues page, you can create issues to report bugs and request new features. On the PyMAPDL Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email PyAnsys Core team. Unfortunately, this team cannot answer specific library questions or issues. You must use the PyMAPDL Issues and PyMAPDL Discussions pages for raising issues, request new features, and asking questions.

You can contribute to PyMAPDL by developing new features, fixing bugs, improving the documentation, fixing typos, writing examples, etc. To learn how to contribute to PyMAPDL, visit Contributing section.

AI-Assisted Development with Specialized Agents

PyMAPDL includes specialized AI agent configurations to help with development, testing, documentation, and code review. These agents work with any LLM-enabled IDE (GitHub Copilot, Cursor, JetBrains AI, etc.):

• Documentation Specialist: Reviews docs, validates docstrings, checks spelling and style
• PyMAPDL Developer: Writes features, fixes bugs, ensures code quality
• Test Engineer: Maintains test coverage, implements mocking strategies
• Code Reviewer: Comprehensive PR reviews ensuring quality standards

See AGENTS.md for detailed agent specifications and .github/AGENTS_GUIDE.md for usage examples.

Project transition - legacy support

This project was formerly known as pyansys, and we'd like to thank all the early adopters, contributors, and users who submitted issues, gave feedback, and contributed code through the years. The pyansys project has been taken up at Ansys and is being leveraged in creating new Pythonic, cross-platform, and multi-language service-based interfaces for Ansys's products. Your contributions to pyansys has shaped it into a better solution.

The pyansys project is expanding beyond just MAPDL, and while there are many new features and changes to the original Python module, many steps have been taken to ensure compatibility with legacy code while supporting new features. The original Python module has been split up into the following projects and modules:

• ansys.mapdl.core
• ansys.mapdl.reader
• ansys.mapdl.corba

For more information on each project, visit their GitHub pages.

Citing this module

If you use PyMAPDL for research and would like to cite the module and source, you can visit pyansys Zenodo and generate the correct citation. For example, the BibTex citation is:

@software{alexander_kaszynski_2020_4009467,
  author       = {Alexander Kaszynski},
  title        = {{pyansys: Pythonic interface to MAPDL}},
  month        = nov,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {0.60.3},
  doi          = {10.5281/zenodo.4009466},
  url          = {https://doi.org/10.5281/zenodo.4009466}
}

Because the citation here might not be current, visit the link above to obtain the most recent citation.

License and acknowledgments

PyMAPDL is licensed under the MIT license.

ansys-mapdl-core package makes no commercial claim over Ansys whatsoever. This tool extends the functionality of MAPDL by adding a Python interface to the MAPDL service without changing the core behavior or license of the original software. The use of the interactive APDL control of PyMAPDL requires a legally licensed local copy of Ansys.

To get a copy of Ansys, visit Ansys.