Launch Sherlock

To launch Sherlock, use the launch_sherlock method. This method takes an optional port parameter and automatically searches for the latest version of Sherlock installed locally. It then launches the Sherlock gRPC server on the port specified. If no port is specified, port 9090 is used by default.

This method also launches a Sherlock client connected to the same port and returns a sherlock gRPC connection object that can be used to invoke the APIs from their respective services.

To start the Sherlock gRPC server on the default port:

from ansys.sherlock.core import launcher
sherlock = launcher.launch_sherlock()

To start the Sherlock gRPC server on a port other than the default, use the port parameter:

from ansys.sherlock.core import launcher
sherlock = launcher.launch_sherlock(port=11000)

You can use the nsys.sherlock.core.common.Common.check>() method to perform a health check on the sherlock gRPC connection object:

sherlock.common.check()