Client

class ansys.result_explorer.core.Client(session_id: str, host: str = 'localhost', grpc_port: int = 50000, ca_cert_path: str | Path | None = None, insecure: bool = False, custom_headers: list[tuple[str, str]] | None = None, instance: ResultExplorerInstance | None = None)

Client for communicating with Result Explorer.

Provides gRPC-based access to Result Explorer services for managing solutions, workspaces, and result providers.

Methods

Client.app_settings()	Get current application settings.
Client.authenticate_result_provider(token[, ...])	Authenticate with a result provider.
Client.connect_with_token(token)	Connect with a base64 encoded json object that contains the connection info.
Client.create_hps_solution(name, project_id, ...)	Create a solution based on a file in the HPS file system of the result provider.
Client.create_result_provider(name, url)	Create a new result provider.
Client.create_solution(name, file_path[, ...])	Create a solution based on a file path.
Client.create_workspace(name[, rows, cols])	Create a new workspace.
Client.delete_result_provider(result_provider)	Delete a result provider.
Client.delete_solution(solution)	Delete a solution.
Client.delete_viewport(viewport)	Delete a viewport.
Client.delete_workspace(workspace)	Delete a workspace.
Client.get_solution(solution_id)	Get a solution by ID.
Client.get_workspace(workspace_id)	Get a workspace by ID.
Client.hps_ls(path[, result_provider])	List entities in the HPS file system of the result provider.
Client.import_workspace_from_template(path, ...)	Create a workspace by importing a template file.
Client.list_result_providers()	List all registered result providers.
Client.list_solutions()	List all solutions in the session.
Client.list_workspaces()	List all workspaces in the session.
Client.ls(path[, result_provider, depth])	List items in a result provider's file system.
Client.open_session(path)	Open a session from file.
Client.save_session(path)	Save the current session to file.
Client.stop()	Stop the Result Explorer instance.
Client.update_app_settings(settings)	Update application settings.

Attributes

Client.app_info	Get application information.
Client.connection_token	Get a base64 encoded json object that contains the connection info.
Client.default_result_provider	Get the default result provider name.
Client.instance	Get the Result Explorer instance.
Client.web_session	Get the web session.
Client.web_url	Get the web UI URL.