Contributing#

Overall guidance on contributing to a PyAnsys repository appears in the Contributing topic in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with it and all Guidelines and Best Practices before attempting to contribute to PyPIM.

The following contribution information is specific to PyPIM.

Cloning the PyPIM Repository#

Run this code to clone and install the latest version of PyPIM in development mode:

git clone https://github.com/pyansys/pypim.git
cd pypim/

Running Tests#

Test automation relies on tox, which can be installed with:

pip install tox

Tests are entirely based on mocks and do not require any external software. Run the tests with the following code:

tox -e py

Building the Documentation#

You can build PyPIM documentation with:

tox -e doc

Building the Package#

The PyPIM package is built using flit.

You can build the package with:

flit build

You can also directly install PyPIM in your current environment with:

flit install

Release Process#

PyPIM follows the same branching model as other PyAnsys libraries and the same release procedure.

The only notable difference is that the documentation is created with tox -e doc rather than with make.