launch_result_explorer#

ansys.result_explorer.core.launch_result_explorer(server_config: ServerLaunchConfig | None = None, web_config: WebLaunchConfig | None = None) → Client#

Launch a Result Explorer instance and return a configured Client.

Convenience function to launch a Result Explorer instance and return a Client configured with that instance’s connection details. The instance lifecycle is tied to the client; when the client is destroyed, the instance will be stopped.

Parameters:

server_configServerLaunchConfig, optional: Server configuration. If None, default configuration is used.
web_configWebLaunchConfig, optional: Web UI configuration. If None, default configuration is used.

Returns:

Client: A Client instance configured to connect to the launched server. The instance lifecycle is tied to this client.

Examples

Launch with default settings and system default browser:

>>> server_config = ServerLaunchConfig(port=5100, ssl=False, auth=False)
>>> web_config = WebLaunchConfig(browser_type=BrowserType.SYSTEM_DEFAULT)
>>> client = launch_result_explorer(server_config, web_config)
>>> # Use the client...
>>> # Instance is cleaned up automatically when client is destroyed

Launch with Playwright in headless mode:

>>> server_config = ServerLaunchConfig(port=5100)
>>> web_config = WebLaunchConfig(browser_type=BrowserType.PLAYWRIGHT_CHROMIUM_HEADLESS)
>>> client = launch_result_explorer(server_config, web_config)
>>> # Use the client to interact with Result Explorer