ansys-simai-core 0.1.0

A python wrapper for Ansys SimAI

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:

1. Start by cloning this repository:

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

2. Install PDM

3. Use PDM to create a virtual env with the dependencies and activate it

   pdm install
   eval $(pdm venv activate)

4. Finally, verify your development installation by running:

   tox

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: checs 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:

python -m pip install pre-commit && pre-commit install

Documentation

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

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

PDM commands can help you build or publish the package

pdm build
pdm publish