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 it and Coding Style before attempting to contribute to PyFluent.

The following contribution information is specific to PyFluent Visualization.

Cloning the PyFluent Visualization Repository

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

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

Building Documentation

To build the documentation locally you need to follow these steps at the root directory of the repository:

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 and you can load the index.html into a web browser. To clean the documentation you can execute this command:

make clean

Posting Issues

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

Code Style

PyFluent is compliant with PyAnsys Development Code Style Guide. Code style is checked by making use of pre-commit. Install this tool and activate it executing the following commands:

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

Then, you can use the style rule defined in the Makefile:

make style

Or directly execute pre-commit:

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