Skip to content
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

Write CFD example into documentation #3953

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

EamonTracey
Copy link
Contributor

Proposed Changes

I propose adding a new example to the TaskVine documentation. This is a real-world example of a TaskVine application currently used by the Notre Dame Rocketry Team to perform CFD simulations at high throughput.

Merge Checklist

The following items must be completed before PRs can be merge.
Check these off to verify you have completed all steps.

  • make test Run local tests prior to pushing.
  • make format Format source code to comply with lint policies. Note that some lint errors can only be resolved manually (e.g., Python)
  • make lint Run lint on source code prior to pushing.
  • Manual Update Update the manual to reflect user-visible changes.
  • Type Labels Select a github label for the type: bugfix, enhancement, etc.
  • Product Labels Select a github label for the product: TaskVine, Makeflow, etc.
  • PR RTM Mark your PR as ready to merge.

Copy link
Member

@dthain dthain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good overall, and glad you got it working.

However, the missing piece for anyone else who would want to use this is the assumption of how fluent is installed. Make sure you put into the instructions some discussion of how this assumes that Fluent has already been installed such that module load is used to activate it. That may be common but not a universal assumption;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants