With Lumerical 2023 R1.2 and later, it is possible to use the Python API remotely. This documentation will show how to run the interop server required to use the remote API.
Note: the interop server is available on Linux only. Three shell scripts are provided, located in
[path to Lumerical]/api/interop-server/scripts/linux
The interop server requires a certificate to encrypt the communication between the client and the server. You can use your own certificate, or use the script generate_certificate.sh to generate them and place them in the user’s home folder, in
To run the script, move to the folder and run generate_certificate.sh. For example, if Lumerical 2023 R1.2 is installed in the default location:
Start and stop the interop server
To start the interop server, run interop_server_start.sh from the same folder.
The server accepts the following options:
- interface IP address [default is 127.0.0.1]
- port [default is 8989]
- Path to server's key
- Path to server’s certificate
Note the parameters have to be specified in that order. For example, if you want to specify the server’s key, you have to specify the previous ones as well (IP address and port).
The interop server should be able to receive incoming connection on the specified port. You may want to open the port or disable the firewall on the machine. Please refer to your Linux distribution documentation. You will need to open a range of ports above the starting port in order to handle multiple connections. We suggest the starting port plus a range of at least 5.
To stop the server, run (from the same folder):