-
Notifications
You must be signed in to change notification settings - Fork 50
docs: Add Podman Usage Examples and Documentation Improvements [skip tests] #4224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+139
−79
Conversation
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
seanpearsonuk
approved these changes
Jul 7, 2025
prmukherj
approved these changes
Jul 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
dependencies
Related to dependencies
documentation
Documentation related (improving, adding, etc)
examples
Publishing PyFluent examples
maintenance
General maintenance of the repo (libraries, cicd, etc)
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.
Summary
This pull request enhances the documentation of search feature and user guidance for running Ansys Fluent containers with Podman. The changes include:
Added new examples for search feature.
Added unique examples for each case.
Added Podman command-line usage examples:
Step-by-step instructions for pulling Docker images into Podman, verifying images, and running containers in both solver and meshing modes.
Updated PyFluent integration instructions:
Clear guidance on using PyFluent with Podman, including environment variable configuration and example Python code.
Improved formatting and clarity:
Reorganized documentation sections for better readability and consistency.
Details
Users are now provided with explicit Podman commands to:
Pull images from the Docker daemon into Podman.
List local Podman images.
Run Ansys Fluent containers with the required license environment variable.
Added a dedicated section for running containers using PyFluent, with updated code snippets and environment variable setup.
Enhanced documentation structure with clear section headers and improved code formatting for ease of use.
Motivation
These updates address new examples for search feature and user requests for Podman support and make it easier for both new and existing users to run Ansys Fluent containers in different environments.
Please review and let me know if further changes are needed!