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 PyMAPDL Examples.

The following contribution information is specific to PyMAPDL Examples.

Clone the repository

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

git clone https://github.com/ansys/pymapdl-examples
cd pymapdl-examples

Post issues

Use the PyMAPDL Examples 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.

Python virtual environment

The use of a Python virtual environment is recommended. To create one, run the following commands:

python -m venv .venv
 .\.venv\Scripts\activate

To deactivate the virtual environment, run this command:

deactivate

Build documentation

To build the documentation for PyMAPDL Examples locally, in the root directory of the repository, run these commands:

pip install -r .\requirements\requirements_doc.txt
.\doc\make.bat html

Adhere to code style

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

pre-commit is a multi-language package manager for pre-commit hooks. To ensure that your code meets minimum code styling standards, install pre-commit with this command:

pip install pre-commit

Once installed, you can run code style checks with this command:

pre-commit run --all-files

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

pre-commit install

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

$ pre-commit install
$ git commit -am "added my cool feature"
black....................................................................Passed
blacken-docs.............................................................Passed
isort....................................................................Passed
flake8...................................................................Passed
codespell................................................................Passed
check for merge conflicts................................................Passed
debug statements (python)................................................Passed
Validate GitHub Workflows................................................Passed