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, paying particular attention to the Coding Style topic, before attempting to contribute to PyFluent.
The following contribution information is specific to PyFluent.
Clone the repository#
To clone and install the latest PyFluent release in development mode, run:
git clone https://github.com/ansys/pyfluent.git cd pyfluent pip install pip -U pip install -e .
To build the PyFluent 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 file in
this directory into a web browser.
You can clear all HTML files from the
_builds/html directory with:
Use the PyFluent Issues page to submit questions, report bugs, and request new features.
Adhere to code style#
PyFluent is compliant with the PyAnsys code style. It uses the tool pre-commit to check the code style. You can install and activate this tool with:
python -m pip install pre-commit pre-commit install
You can then use the
style rule defined in
Or, you can directly execute pre-commit with:
pre-commit run --all-files --show-diff-on-failure