Getting started

This section describes how to install PyAdditive-Widgets in user mode and quickly begin using it. If you are interested in contributing to PyAdditive-Widgets, see Contribute for information on installing in developer mode.

Prerequisites

The use of PyAdditive-Widgets requires the installation of a licensed copy of Ansys 2024 R1 or later and PyAdditive 0.17.2 or later.

The PyAdditive simulations described in this documentation also require a license for the Ansys Additive Suite. To obtain a license, contact your Ansys sales representative or complete this inquiry form.

Package dependencies

PyAdditive-Widgets is supported on Python version 3.9 and later. Previous versions of Python are no longer supported as outlined on the History page describing the transition from Python 2 to Python 3.

Dependencies for PyAdditive-Widgets are automatically checked when packages are installed. Included in the dependencies are these projects:

• ansys-additive-core: PyAdditive is a Python client library for the Ansys Additive service.

• Panel: A web app framework for Python that is used for interactive visualization of PyAdditive results.

Install the package

1. Before installing PyAdditive-Widgets, make sure that you have the latest version of pip with this command:

   python -m pip install -U pip
   

2. Install PyAdditive-Widgets with this command:

   python -m pip install ansys-additive-widgets
   

For information on starting a session with the PyAdditive client and running simulations, see User guide.