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 PyAEDT.

The following contribution information is specific to PyAEDT.

Cloning the PyAEDT Repository

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

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

Posting Issues

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

To reach the project support team, email pyansys.support@ansys.com.

Viewing PyAEDT Documentation

Documentation for the latest stable release of PyAEDT is hosted at PyAEDT Documentation.

Documentation for the latest development version, which tracks the main branch, is hosted at Development PyAEDT Documentation. This version is automatically kept up to date via GitHub actions.

Code Style

PyAEDT follows PEP8 standard as outlined in the PyAnsys Development Guide and implements style checking using pre-commit.

To ensure your code meets minimum code styling standards, run:

pip install pre-commit
pre-commit run --all-files

You can also install this as a pre-commit hook by running:

pre-commit install

This way, it’s not possible for you to push code that fails the style checks. For example:

$ pre-commit install
$ git commit -am "added my cool feature"
black....................................................................Passed
isort....................................................................Passed
flake8...................................................................Passed
codespell................................................................Passed