Skip to content

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Jul 20, 2025

User description

for @henryleberre


PR Type

Documentation


Description

  • Update README badges with improved styling and colors

  • Add new citation section with DOI and BibTeX

  • Enhance welcome message and project description

  • Update supercomputer references and achievements


Diagram Walkthrough

flowchart LR
  A["Old README"] --> B["Badge Updates"]
  A --> C["Citation Section"]
  A --> D["Content Updates"]
  B --> E["Enhanced README"]
  C --> E
  D --> E
Loading

File Walkthrough

Relevant files
Documentation
README.md
Comprehensive README enhancement with citations and styling

README.md

  • Replace old badges with styled versions using custom colors
  • Add new DOI badge and citation section with BibTeX format
  • Update welcome message and project description text
  • Add reference to 101 trillion grid point simulation achievement
  • Update supercomputer listings to include newer systems
+32/-9   

Copilot AI review requested due to automatic review settings July 20, 2025 14:24
@sbryngelson sbryngelson merged commit e521af1 into MFlowCode:master Jul 20, 2025
12 checks passed
@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
⚡ Recommended focus areas for review

Possible Issue

The URL encoding in badge URLs contains '%09' characters which appear to be tab characters. This could cause the badges to not display correctly or break the links.

  <img src="https://img.shields.io/github/actions/workflow/status/mflowcode/mfc/test.yml?style=flat&label=Tests&color=slateblue%09"/>
</a>
<a href="https://github.com/MFlowCode/MFC/blob/master/.github/CONTRIBUTING.md">
  <img src="https://img.shields.io/github/contributors-anon/mflowcode/mfc?style=flat&color=darkslategrey%09" />
</a>
<a href="https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw">
  <img src="https://img.shields.io/badge/slack-MFC-purple.svg?logo=slack" />
</a>
<a href="https://lbesson.mit-license.org/">
  <img src="https://img.shields.io/badge/License-MIT-crimson.svg" />
Content Accuracy

The claim about "101 trillion grid points" being the "largest known, open CFD simulation" as of July 2025 should be verified for accuracy, especially since today's date is July 2025.

MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2505.07392" target="_blank">101 trillion grid points</a> (as of July 2025).

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the README.md file to refresh badges, improve branding, and add a prominent citation section. The changes modernize the visual presentation and emphasize MFC's achievements in exascale computing.

Key Changes:

  • Updated badge styling with new color schemes and improved test status display
  • Added a prominent citation section with DOI and BibTeX entry for MFC 5.0
  • Enhanced the welcome section with claims about the largest known open CFD simulation

**Welcome!**
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
It uses metaprogramming to stay short and portable (~20K lines).
MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2505.07392" target="_blank">101 trillion grid points</a> (as of July 2025).
Copy link

Copilot AI Jul 20, 2025

Choose a reason for hiding this comment

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

The arXiv URL (2505.07392) does not match the DOI and citation provided later in the document (2503.07953). This inconsistency should be resolved to ensure accurate referencing.

Suggested change
MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2505.07392" target="_blank">101 trillion grid points</a> (as of July 2025).
MFC conducted the largest known, open CFD simulation at <a href="https://arxiv.org/abs/2503.07953" target="_blank">101 trillion grid points</a> (as of July 2025).

Copilot uses AI. Check for mistakes.
<img src="https://img.shields.io/github/stars/MFlowCode/MFC?style=flat&color=maroon"/>
</a>

</br>
Copy link

Copilot AI Jul 20, 2025

Choose a reason for hiding this comment

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

Use <br> instead of </br> for line breaks in HTML. The closing tag syntax is incorrect for the self-closing br element.

Suggested change
</br>
<br>

Copilot uses AI. Check for mistakes.
@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix invalid URL encoding

Remove the URL-encoded tab character (%09) from the color parameter. This
invalid encoding can cause the badge to display incorrectly or fail to load.

README.md [9]

-<img src="https://img.shields.io/github/actions/workflow/status/mflowcode/mfc/test.yml?style=flat&label=Tests&color=slateblue%09"/>
+<img src="https://img.shields.io/github/actions/workflow/status/mflowcode/mfc/test.yml?style=flat&label=Tests&color=slateblue"/>
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies and removes an invalid URL-encoded tab character (%09) from a badge URL, improving the URL's correctness.

Low
Remove malformed URL encoding

Remove the URL-encoded tab character (%09) from the color parameter. This
malformed URL parameter will prevent the badge from rendering properly.

README.md [12]

-<img src="https://img.shields.io/github/contributors-anon/mflowcode/mfc?style=flat&color=darkslategrey%09" />
+<img src="https://img.shields.io/github/contributors-anon/mflowcode/mfc?style=flat&color=darkslategrey" />
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies and removes an invalid URL-encoded tab character (%09) from a badge URL, improving the URL's correctness.

Low
  • More

@sbryngelson sbryngelson deleted the test branch August 1, 2025 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

1 participant