Conversation
github-actions
Bot
added
the
documentation
Up to standards ✅🟢 Issues
|
mkundu1
requested review from
hpohekar,
mayankansys,
prmukherj and
seanpearsonuk
and removed request for
mayankansys
prmukherj
approved these changes
Jun 8, 2026
| Using a virtual environment | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| It is recommended to use a virtual environment when installing PyFluent to avoid conflicts with other Python packages. |
Collaborator
There was a problem hiding this comment.
Shouldn't we provide a more comprehensive rationale for using a virtual environment?
Contributor
Author
There was a problem hiding this comment.
@seanpearsonuk Using a virtual environment is a standard practice for Python development and anything more we say here will become duplicate of official Python documentation. Should we just provide a link to the Python tutorial (https://docs.python.org/3/tutorial/venv.html) here?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Usage of virtual environment was not mentioned in PyFluent docs (as the project was inherited from ansys-templates which also doesn't mention it). If virtual environment is not used, users can overwrite bundled PyFluent within an unified installation when they use Python from the unified installation.
Change Summary
Steps how to setup and use virtual environment while installing PyFluent in both default and developer mode have been mentioned in README and the installation guide. There was an FAQ entry for virtual environment-based setup which has been removed as the information is redundant.
Rationale
Using virtual environment while installing a Python package is a standard procedure and mentioning the same in PyFluent docs will guide users to follow best practices.
Impact
Installation guide will be improved.