Getting started#

PySpeos is a Python client library that gathers functionalities and tools based on remote API of Ansys software Speos .

Installation#

You can use pip to install PySpeos.

pip install ansys-speos-core

Available modes#

This client library works with a Speos service backend. There are several ways of running this backend, although the preferred and high-performance mode is using Docker containers. Select the option that best suits your needs.

Docker containers

Launch the Speos service as a Docker container and connect to it from PySpeos.

Docker containers
Local service

Launch the Speos service locally on your machine and connect to it from PySpeos.

Launch a local service
Remote service

Launch the Speos service on a remote machine and connect to it using PIM (Product Instance Manager).

Launch a remote service
Connect to an existing service

Connect to an existing Speos service locally or remotely.

Use an existing service

Development installation#

In case you want to support the development of PySpeos, install the repository in development mode. For more information, refer to the README.

Frequently asked questions#

Any questions? Refer to Q&A before submitting an issue.