Skip to content

Conversation

@prathi-wind
Copy link
Collaborator

@prathi-wind prathi-wind commented Jul 20, 2025

User description

Description

There was a bug with rendering the page since I included a quotation mark inside a code segement. Doxygen treats quotations inside code oddly, so it was removed.

Fixes #(issue) [optional]

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Something else

Scope

  • This PR comprises a set of related changes with a common goal

If you cannot check the above box, please split your PR into multiple PRs that each have a common goal.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • What computers and compilers did you use to test this:

Checklist

  • I have added comments for the new code
  • I added Doxygen docstrings to the new code
  • I have made corresponding changes to the documentation (docs/)
  • I have added regression tests to the test suite so that people can verify in the future that the feature is behaving as expected
  • I have added example cases in examples/ that demonstrate my new feature performing as expected.
    They run to completion and demonstrate "interesting physics"
  • I ran ./mfc.sh format before committing my code
  • New and existing tests pass locally with my changes, including with GPU capability enabled (both NVIDIA hardware with NVHPC compilers and AMD hardware with CRAY compilers) and disabled
  • This PR does not introduce any repeated code (it follows the DRY principle)
  • I cannot think of a way to condense this code and reduce any introduced additional line count

If your code changes any code source files (anything in src/simulation)

To make sure the code is performing as expected on GPU devices, I have:

  • Checked that the code compiles using NVHPC compilers
  • Checked that the code compiles using CRAY compilers
  • Ran the code on either V100, A100, or H100 GPUs and ensured the new feature performed as expected (the GPU results match the CPU results)
  • Ran the code on MI200+ GPUs and ensure the new features performed as expected (the GPU results match the CPU results)
  • Enclosed the new feature via nvtx ranges so that they can be identified in profiles
  • Ran a Nsight Systems profile using ./mfc.sh run XXXX --gpu -t simulation --nsys, and have attached the output file (.nsys-rep) and plain text results to this PR
  • Ran a Rocprof Systems profile using ./mfc.sh run XXXX --gpu -t simulation --rsys --hip-trace, and have attached the output file and plain text results to this PR.
  • Ran my code using various numbers of different GPUs (1, 2, and 8, for example) in parallel and made sure that the results scale similarly to what happens if you run without the new code/feature

Went from this:
image
to this:
image


PR Type

Bug fix


Description

  • Fixed quotation marks in code block causing rendering issues

  • Corrected markdown link formatting

  • Minor formatting improvements for documentation


File Walkthrough

Relevant files
Documentation
gpuDebugging.md
Fix documentation rendering and formatting issues               

docs/documentation/gpuDebugging.md

  • Removed problematic quotation marks from code block that caused
    Doxygen rendering issues
  • Fixed broken markdown link formatting for LLVM OpenMP documentation
  • Minor formatting adjustments for consistency
+4/-4     

@prathi-wind prathi-wind self-assigned this Jul 20, 2025
@prathi-wind prathi-wind requested a review from a team as a code owner July 20, 2025 15:50
@prathi-wind prathi-wind added bug Something isn't working or doesn't seem right documentation Improvements or additions to documentation labels Jul 20, 2025
@qodo-merge-pro
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@sbryngelson sbryngelson merged commit 55b1412 into MFlowCode:master Jul 20, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working or doesn't seem right documentation Improvements or additions to documentation Review effort 1/5

Development

Successfully merging this pull request may close these issues.

2 participants