Launch the Speos service#

Manually launch the Speos service.

Environment variables#

The Speos service requires this mandatory environment variable to function properly:

  • ANSYSLMD_LICENSE_FILE: License server (port and IP address or DNS) the Speos service connects to. For example, 1055@127.0.0.1.

You can also specify other optional environment variables:

  • SPEOS_LOG_LEVEL: Sets the Speos service logging level. The default is 2, in which case the logging level is INFO.

Here are some terms to keep in mind:

  • host: Machine that hosts the Speos service. It is typically on localhost. But if you are deploying the service on a remote machine, then the machine’s IP address is expected. By default, PySpeos assumes it is on localhost.

  • port: Port that exposes the Speos service on the host machine. Its value is assumed to be 50098, but users can deploy the service on preferred ports.

Docker for Speos service#

This method allows you to start the Speos service based on predefined environment variables and properties. Afterwards, see the next section to understand how to connect to this service instance from PySpeos.

The following snippet shows how to run Speos service 2025.1. To use another product version, please modify the image label from 251 to the corresponding product version.

export LICENSE_SERVER="1055@XXX.XXX.XXX.XXX"
docker run --detach --name speos-rpc -p 50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252

$env:LICENSE_SERVER="1055@XXX.XXX.XXX.XXX"
docker run --detach --name speos-rpc -p 50098:50098 -e ANSYSLMD_LICENSE_FILE=$env:LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252

set LICENSE_SERVER="1055@XXX.XXX.XXX.XXX"
docker run --detach --name speos-rpc -p 50098:50098 -e ANSYSLMD_LICENSE_FILE=%LICENSE_SERVER% --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:252

Connect to the Speos service#

After the Speos service is launched, connect to it with these commands:

from ansys.speos.core import Speos

speos = Speos()

By default, the Speos instance connects to 127.0.0.1 ("localhost") on port 50098.

You can change this by modifying the host and port parameters of the Speos object, but note that you must also modify your docker run command by changing the <HOST-PORT>-50098 argument.

The following tabs show the commands that set the environment variables and Speos function.

from ansys.speos.core import Speos

speos = Speos(host="127.0.0.1", port=50098)