Configuration file#

To create a SimAIClient instance from a configuration file, you use the from_config() method:

simai = ansys.simai.core.from_config()

Location#

If no path is given, the SimAIClient instance looks at default locations. These locations differ according to your operating system.

Linux/MacOS

For UNIX systems, the default locations are, in order:

  • $XDG_CONFIG_HOME/ansys_simai.conf

  • $XDG_CONFIG_HOME/ansys/simai.conf

  • ~/.ansys_simai.conf

  • ~/.ansys/simai.conf

  • /etc/ansys_simai.conf

  • /etc/ansys/simai.conf

Note

The first location found is used. $XDG_CONFIG_HOME defaults to ~/.config.

Windows XP

  • C:\Documents and Settings\<user>\Local Settings\Application Data\Ansys\simai.conf

Windows 7 to 11

  • C:\Users\<user>\AppData\Roaming\Ansys\simai.conf

Optionally, you can specify the path yourself:

simai = ansys.simai.core.from_config(path="/path/to/my/config")

Content#

You write the configuration file in TOML. From this file, you can pass parameters for configuring the SimAIClient instance.

Example#

[default]
organization = "company"

[default.credentials]
username = "user@company.com"
password = "hunter12"
totp_enabled = true

Proxy#

If your network is situated behind a proxy, you must add its address in a https_proxy key in the [default] block:

[default]
organization = "company"
https_proxy = "http://company_proxy_host:3128" # replacing host and port by the real value

Profiles#

The SimAIClient instance supports having multiple configurations in a single file through profiles, which are loaded like this:

[default]
organization = "company"
workspace = "my-usual-workspace"

[alternative]
organization = "company"
workspace = "some-other-workspace"
project = "red herring"

simai = ansys.simai.core.from_config(profile="alternative")