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

docs: add in-situ analysis #586

Merged
merged 6 commits into from
Apr 4, 2024
Merged

Conversation

BenWibking
Copy link
Collaborator

@BenWibking BenWibking commented Mar 29, 2024

Description

Adds documentation for enabling in-situ analysis of simulations.

Also: updates the documentation on how to read a time series of plotfiles with VisIt.

Related issues

N/A

Checklist

Before this pull request can be reviewed, all of these tasks should be completed. Denote completed tasks with an x inside the square brackets [ ] in the Markdown source below:

  • I have added a description (see above).
  • I have added a link to any related issues see (see above).
  • I have read the Contributing Guide.
  • I have added tests for any new physics that this PR adds to the code.
  • I have tested this PR on my local computer and all tests pass.
  • I have manually triggered the GPU tests with the magic comment /azp run.
  • I have requested a reviewer for this PR.

@BenWibking BenWibking added the documentation Improvements or additions to documentation label Mar 29, 2024
@markkrumholz
Copy link
Collaborator

I'll hold off on reviewing this until #581 is finalized and merged, since the exact functionality is still being iterated.

Copy link
Collaborator

@markkrumholz markkrumholz left a comment

Choose a reason for hiding this comment

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

See inline comments.

@BenWibking
Copy link
Collaborator Author

I've re-worded things to avoid "weighting" as you suggested. Let me know if it is sufficiently clear.

@BenWibking
Copy link
Collaborator Author

@markkrumholz Can you re-review?

Copy link
Collaborator

@markkrumholz markkrumholz left a comment

Choose a reason for hiding this comment

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

Two final minor comments: in the example input file for on-the-fly PDFs, the documentation / comments do not currently state the default behavior for the weight-by and min/max options. You should state what these default to, i.e., if you don't specify how to weight, is it weighted by mass, volume, cell count? What are the default choices for min/max if you don't specify?

@BenWibking
Copy link
Collaborator Author

Two final minor comments: in the example input file for on-the-fly PDFs, the documentation / comments do not currently state the default behavior for the weight-by and min/max options. You should state what these default to, i.e., if you don't specify how to weight, is it weighted by mass, volume, cell count? What are the default choices for min/max if you don't specify?

I've added both of these. See inline comments.

@BenWibking BenWibking added this pull request to the merge queue Apr 3, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Apr 4, 2024
@BenWibking BenWibking added this pull request to the merge queue Apr 4, 2024
Merged via the queue into development with commit d13e3bc Apr 4, 2024
16 checks passed
@BenWibking BenWibking deleted the BenWibking/docs-inline-analysis branch July 31, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants