Workspaces#
Workspaces are a set of specific geometries, predictions, and postprocessings. Each workspace uses a specific kernel.
You use the SimAIClient.set_current_workspace()
method to set the workspace that the client is configured for.
Directory#
- class WorkspaceDirectory#
Provides a collection of methods related to workspaces.
This class is accessed through
client._workspaces
.Example
import ansys.simai.core simai = ansys.simai.core_from_config() simai.workspaces.list()
Model#
- class Workspace#
Provides the local representation of a workspace object.
- delete()#
Delete the workspace.
- download_mer_data(file: BinaryIO | RawIOBase | BufferedIOBase | Path | str | PathLike | None = None) None | BinaryIO #
Download the the names, subsets and plotting data of the files used in the AI model and MER for the workspace.
- download_model_evaluation_report(file: BinaryIO | RawIOBase | BufferedIOBase | Path | str | PathLike | None = None) None | BinaryIO #
Download the PDF of the model evaluation report for the workspace.
- set_as_current_workspace() None #
Configure the client to use this workspace instead of the one currently configured.
- property model: ModelManifest#
Deprecated alias to
model_manifest
.
- property model_manifest: ModelManifest#
ModelManifest
instance containing information about the model associated with the workspace.
ModelManifest#
- class ModelManifest#
Provides information about a model associated with a workspace.
- property boundary_conditions: Dict[str, Any]#
Information on the boundary conditions expected by the model. For example, the prediction’s input.
- property physical_quantities: Dict[str, Any]#
Information on the physical quantities generated by the model. For example, the prediction’s output.