Getting started

Installation

Two installation modes of the pyansys-tools-variableinterop package are provided: user and developer.

Install in user mode

Before installing the pyansys-tools-variableinterop package, make sure that you have the latest version of pip with this command:

python -m pip install -U pip

Then, install the latest pyansys-tools-variableinterop package with this command:

python -m pip install pyansys-tools-variableinterop

Install in developer mode

Installing the pyansys-tools-variableinterop package in developer mode allows you to modify the source and enhance it. For more information, see Contribute.

Style and testing

If required, you can call style commands (such as black, isort, and flake8) or unit testing commands (such as pytest) from the command line. However, this does not guarantee that your project is being tested in an isolated environment, which is why you might consider using tox.

Distributing

If you would like to create either source or wheel files, start by running this command to install the building requirements:

python -m pip install -e .[doc,tests]

Then, run these commands:

python -m build
python -m twine check dist/*