Install PyMAPDL

Python module

Note

These instructions assume you are working on Windows/macOS/Linux and are familiar with pip and the command line. If they are new to you, you should read the Python Packaging User Guide Tutorial on pip <python_installing_packages> before proceeding.

The ansys.mapdl.core package currently supports Python 3.10 through Python 3.13 on Windows, macOS, and Linux.

Install the latest release from PyPi with this command on the command line, terminal, or in PowerShell:

pip install ansys-mapdl-core

Alternatively, install the latest release from PyMAPDL GitHub with this command:

pip install git+https://github.com/ansys/pymapdl.git

For a local development version, install with the following commands. If you are unfamiliar with git or do not have it installed, see the contributing to PyMAPDL guide <_developing_pymapdl> for more information.

git clone https://github.com/ansys/pymapdl.git
cd pymapdl
pip install -e .

After installing a development version, you can modify the ansys-mapdl-core package locally and have the changes reflected in your setup after restarting the Python kernel.

Offline installation

If you lack an internet connection on your installation machine, the recommended way of installing PyMAPDL is downloading the wheelhouse archive from the Releases page for your corresponding machine architecture.

Each wheelhouse archive contains all the Python wheels necessary to install PyMAPDL from scratch on Windows and Linux. You can install this on an isolated system with a fresh Python installation or on a virtual environment.

For example, on Linux with Python 3.10, unzip the wheelhouse archive, and install it with these commands:

unzip PyMAPDL-v0.68.dev1-wheelhouse-Linux-3.10.zip wheelhouse
pip install ansys-mapdl-core -f wheelhouse --no-index --upgrade --ignore-installed

If you’re on Windows with Python 3.10, unzip to a wheelhouse directory and install using the preceding command.

Consider installing using a virtual environment.

Verify your installation

Note

To use PyMAPDL, you must have a local installation of Ansys. The version of Ansys installed dictates the interface and features available to you.

For more information on getting a licensed copy of Ansys, visit Ansys.

Check that you have installed the package correctly by importing the module:

>>> from ansys.mapdl import core as pymapdl

For information on launching PyMAPDL and connecting it to an MAPDL instance, see _ref_launch_pymapdl.