PySimAI

A Python wrapper for Ansys SimAI

How to install

At least two installation modes are provided: user and developer.

For users

In order to install PySimAI, make sure you have the latest version of pip. To do so, run:

python -m pip install -U pip

Then, you can simply execute:

python -m pip install ansys-simai-core

For developers

Installing PySimAI in developer mode allows you to modify the source and enhance it.

Before contributing to the project, please refer to the PyAnsys Developer’s guide. You will need to follow these steps:

Start by cloning this repository:

git clone https://github.com/ansys/pysimai

Install uv. NB: If you are a Windows user, make sure that Python is installed on your system and it is added to the Path.
Use uv to run commands
```
uv run pytest -xlv
```
Finally, verify your development installation by running:
```
uv tool install tox --with tox-uv
tox
```

Alternatively, you can also run tasks defined in pyproject.toml using poethepoet:

uv tool install poethepoet
uv run poe lint
uv run poe test
uv run poe doc

How to test

This project takes advantage of tox. This tool allows to automate common development tasks (similar to Makefile) but it is oriented towards Python development.

Using tox

As Makefile has rules, tox has environments. In fact, the tool creates its own virtual environment so anything being tested is isolated from the project in order to guarantee project’s integrity. The following environments commands are provided:

tox -e style: will check for coding style quality.
tox -e py: checks for unit tests.
tox -e py-coverage: checks for unit testing and code coverage.
tox -e doc: checks for documentation building process.

Raw testing

If required, you can always call the style commands (ruff) or unit testing ones (pytest) from the command line. However, this does not guarantee that your project is being tested in an isolated environment, which is the reason why tools like tox exist.

A note on pre-commit

The style checks take advantage of pre-commit. Developers are not forced but encouraged to install this tool via:

uv tool install pre-commit && pre-commit install

Documentation

For building documentation, you can either run the usual rules provided in the Sphinx Makefile, such as:

uv run make -C doc/ html && open doc/html/index.html

However, the recommended way of checking documentation integrity is using:

tox -e doc && open .tox/doc_out/index.html

Distributing

uv commands can help you build or publish the package

uv build
uv publish

Metadata

Release files for ansys-simai-core 0.4.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansys-simai-core 0.4.7
File	Size	Uploaded
ansys_simai_core-0.4.7.tar.gz	1.0 MB	Sep 29, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ansys-simai-core 0.4.7
File	Interpreter	ABI	Platform	Reset
ansys_simai_core-0.4.7-py3-none-any.whl 164.7 kB Sep 29, 2026	Python 3	none	any	Details

Total release size: 1.2 MB

Release files / ansys_simai_core-0.4.7.tar.gz

Download URL	ansys_simai_core-0.4.7.tar.gz
Size	1.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`7e74cca6a0b66b92031619074dc6f3721954041e6da2729306ee3716088ece86`
BLAKE2b-256 checksum How to use checksums	`a71f4fcd1750abafd8a1caabee5893baf7381fc0fd48194a14ea9ef748eba1e0`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ansys/pysimai
Publishing commit: github.com/ansys/pysimai/tree/112fb9e4ab4f8f3a83ca32cb19533d57b3b13901

Workflow

Publishing configuration: github.com/ansys/pysimai/blob/112fb9e4ab4f8f3a83ca32cb19533d57b3b13901/.github/workflows/ci_cd.yml
Publishing logs: github.com/ansys/pysimai/actions/runs/36581480474/attempts/2

Artifact

Subject: ansys_simai_core-0.4.7.tar.gz
SHA-256 checksum: 7e74cca6a0b66b92031619074dc6f3721954041e6da2729306ee3716088ece86 Verifying attestations

Release files / ansys_simai_core-0.4.7-py3-none-any.whl

Download URL	ansys_simai_core-0.4.7-py3-none-any.whl
Size	164.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`56c74ff78f1943b29da75c3f4f1419ae5d1d370d688a0a4a2992b2462a27643e`
BLAKE2b-256 checksum How to use checksums	`458bb287f9e0526590a743e2d0d4388e6d4d306358368f8cebc0916d5ea119ae`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ansys/pysimai
Publishing commit: github.com/ansys/pysimai/tree/112fb9e4ab4f8f3a83ca32cb19533d57b3b13901

Workflow

Publishing configuration: github.com/ansys/pysimai/blob/112fb9e4ab4f8f3a83ca32cb19533d57b3b13901/.github/workflows/ci_cd.yml
Publishing logs: github.com/ansys/pysimai/actions/runs/36581480474/attempts/2

Artifact

Subject: ansys_simai_core-0.4.7-py3-none-any.whl
SHA-256 checksum: 56c74ff78f1943b29da75c3f4f1419ae5d1d370d688a0a4a2992b2462a27643e Verifying attestations