Design of experiments#

This module contains methods for exporting design of experiments in different formats.

class DesignOfExperimentsCollection#

Provides a collection of methods related to design of experiments.

This class is accessed through client.design_of_experiments.

download(file: str | Path, format: str = 'xlsx', workspace: Workspace | str | None = None) → None#

Download the design of experiments data to the specified file or path.

Parameters:

file (str | Path) – Path of the file to put the content into.
format (str) – Expected format. The default is 'xlsx'. Options are 'xlsx' and 'csv'.
workspace (Workspace | str | None) – Workspace to download the design of experiments from. If not specified, the current workspace is used.

Example

import ansys.simai.core

simai = ansys.simai.core.from_config()
simai.design_of_experiments.download(file="~/exp_plan.xlsx", format="xlsx")

in_memory(format: str | None = 'csv', workspace: Workspace | str | None = None) → BytesIO#

Load the design of experiments data in memory.

Parameters:

file – Path of the file to put the content into.
format (str | None) – Expected format. The default is 'csv'. Options are 'xlsx' and 'csv'.
workspace (Workspace | str | None) – Workspace to download the design of experiments from. If not specified, the current workspace is used.

Returns:

BytesIO object containing the design of experiments data.

Return type:

BytesIO

Example

import ansys.simai.core

simai = ansys.simai.core.from_config()
workspace = simai.workspaces.list()[0]
data = simai.design_of_experiments.in_memory(format="csv", workspace=workspace)
# Read data with CSV reader, ...