Contributing

Overall guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with this guide, paying particular attention to the Coding Style topic, before attempting to contribute to PyTwin.

The following contribution information is specific to PyTwin.

Post issues

Use the PyTwin Issues page to submit questions, report bugs, and request new features.

Clone the repository

To clone and install the latest PyTwin release in development mode, run:

git clone https://github.com/pyansys/pytwin.git
cd pytwin
pip install pip -U
pip install -e .

Build documentation

To build the PyTwin documentation locally, in the root directory of the repository, run:

pip install -r requirements/requirements_doc.txt
cd doc
make html

After the build completes, the HTML documentation is located in the _builds/html directory. You can load the index.html file in this directory into a web browser.

You can clear all HTML files from the _builds/html directory with:

make clean

Run unitary tests

To launch pytwin unitary tests automatically and verify that code modifications do not break existing logic, install pytest package into your Python environment and from the root directory, run :

pytest --cov=pytwin --cov-report=term --cov-report=xml:.cov/coverage.xml --cov-report=html:.cov/html tests -vv

Adhere to code style

PyTwin is compliant with the PyAnsys code style. It uses the tool pre-commit to check the code style. You can install and activate this tool with:

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

Or, you can directly execute pre-commit with:

pre-commit run --all-files --show-diff-on-failure