Contribute

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

The following contribution information is specific to PyFluent-Visualization.

Clone the repository

To clone and install the latest version of PyFluent-Visualization in development mode, run:

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

Build documentation

To build the PyFluent-Visualization 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 in this directory into a web browser.

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

make clean

Post issues

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

Adhere to code style

PyFluent-Visualization is compliant with the PyAnsys coding style. It uses the tool pre-commit to check the code style. You can install and active this tool with:

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

You can then use the style rule defined in Makefile with:

make style

Or, you can directly run pre-commit with:

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