Prerequisites#

You can use PySTK locally on Windows and Linux operating systems, or by using Windows-based or Linux-based Docker containers.

Local prerequisites#

To get started using PySTK locally, the following is required:

  • Python

  • A licensed version of the Ansys STK® desktop application or STK Engine

Install Python#

A working Python environment using Python version 3.11 or greater is required. You can download and install Python from https://www.python.org/downloads.

Additionally, you can install Jupyter Notebooks by downloading an install from https://jupyter.org/install.

Note

If using the remote API, modules grpcio and protobuf are required. They can be obtained from PyPI and installed using pip.

Install the STK Desktop application or STK Engine#

The STK desktop application or STK Engine must be installed and licensed on your machine.

Install the STK Desktop application#

STK desktop software is available on Windows platforms. It provides a physics-based modeling environment for analyzing platforms and payloads in a realistic mission context. Refer to the STK installation instructions for details on installing the STK application.

Note

Once installed, refer to the Licensing STK help topic for information on licensing STK software.

Install STK Engine#

STK Engine is available on Windows and Linux platforms. It enables you to build an app that harnesses the analytical power and visual capabilities of the STK application.

Note

Once installed, refer to the Obtaining and registering AGI licenses help topic and navigate to the Obtaining and Registering AGI Licenses section for information on licensing STK Engine.

Docker prerequisites#

You can use PySTK inside a Windows-based Docker container or inside a Linux-based Docker container. To get started, you must have Docker installed. Refer to the links below to install Docker on your desired operating system: