Contribute

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 before attempting to contribute to PyOptiSLang.

The following contribution information is specific to PyOptiSLang.

Clone the repository and install the package

To clone the PyOptiSLang repository and install the latest PyOptiSLang release in development mode, run this code:

git clone https://github.com/ansys/pyoptislang
cd pyoptislang
pip install pip -U
pip install -e .

Post issues

Use the PyOptiSLang Issues page to submit questions, report bugs, and request new features. When possible, use these issue templates:

• Bug report template

• Feature request template

If your issue does not fit into one of these template categories, create your own issue.

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

View documentation

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

In the upper right corner of the documentation’s title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

Adhere to code style

PyOptiSLang follows the 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 this code:

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

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

pre-commit install

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

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