Package

This repository is deployed as the Python packages ansys-speos-core. As usual, installation is done by running:

pip install ansys-speos-core

Sources

Prerequisite: user needs to have a GitHub account and a valid Personal Access Token (see GitHub Settings/Developer settings/Personal access tokens/Generate new token).

git clone https://github.com/ansys/pyspeos.git
cd pyspeos
python -m pip install --upgrade pip
pip install -U pip tox
tox -e style
pip install -e .

from ansys.speos.core.speos import Speos

speos = Speos()

Test configuration file

The configuration file tests/local_config.json located in tests folder contains several parameters that can be changed according to your needs, for example:

• SpeosServerOnDocker (Boolean): Speos server launched in a Docker container.

• SpeosServerPort (integer): Port used by Speos server for HTTP transfer.

Start server

The first option is to use the Docker image from the PySpeos repository on Github.

Use a GitHub personal access token with permission for reading packages to authorize Docker to access this repository. For more information, see Managing your personal access tokens in the GitHub documentation. Save the token to a file with this command:

echo XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX > GH_TOKEN.txt

Since the Docker image contains no license server, you will need to enter your license server IP address in the LICENSE_SERVER environment variable. Then, to launch SpeosRPC server with product version 2025.1, you can run:

export GH_USERNAME=<my-github-username>
export LICENSE_SERVER=1055@XXX.XXX.XXX.XXX

cat GH_TOKEN.txt | docker login ghcr.io -u "$GH_USERNAME" --password-stdin
docker pull ghcr.io/ansys/speos-rpc:261
docker run --detach --name speos-rpc -p 127.0.0.1:50098:50098 -e ANSYSLMD_LICENSE_FILE=$LICENSE_SERVER --entrypoint /app/SpeosRPC_Server.x ghcr.io/ansys/speos-rpc:261 --transport_insecure --host 0.0.0.0

On the other hand, the SpeosRPC server can be started locally.

For Windows:

%AWP_ROOT251%\Optical Products\SPEOS_RPC\SpeosRPC_Server.exe

For Linux:

$AWP_ROOT251\OpticalProducts\SPEOS_RPC\SpeosRPC_Server.x

And test configuration file tests/local_config.json must be updated to use local server:

{
   "SpeosServerOnDocker": false,
   "SpeosContainerName" : "speos-rpc",
   "SpeosServerPort": 50098
}

Launch unit tests

pip install . --group tests
pytest -vx

Use jupyter notebook

pip install . --group jupyter
jupyter notebook

jupyter notebook can be downloaded from the documentations example section.

PySpeos core features

Features supported in the latest release can be found at:

• Optical Materials

• Light Sources

• Sensors

• Simulations

• BSDF Viewer

• Light Path Finder

Speos RPC features

Speos RPC is based on a gRPC server and provides APIs to interact with Speos solver.

Features supported in the latest Speos RPC can be found at: Ansys Speos for developers Speos RPC.