From 48c934d2d87862dcfd7d9e27bde98adb83c8fc2c Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Tue, 4 Nov 2025 11:45:49 -0500 Subject: [PATCH 1/5] docs: Update README and CITATION.cff, add issue templates - Enhanced README with improved structure and examples - Updated CITATION.cff with additional metadata - Added GitHub issue templates for feature requests and configuration --- .github/ISSUE_TEMPLATE/config.yml | 15 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++ CITATION.cff | 104 +++++++++++++++++----- README.md | 42 ++++++++- 4 files changed, 166 insertions(+), 21 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..0e5c8003ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,15 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & support + url: https://github.com/MFlowCode/MFC/discussions + about: Get help, show results, and discuss ideas + - name: Slack community + url: https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw + about: Join our Slack workspace for real-time discussion + + + + + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..c57b4f1c6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Propose an enhancement to MFC +title: '' +labels: enhancement +assignees: '' +--- + +### Problem it solves + + +### Proposed solution + + +### Alternatives + + +### Additional context + + + + + + + + diff --git a/CITATION.cff b/CITATION.cff index e1c3947a4c..05fb733d87 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -4,27 +4,91 @@ cff-version: 1.2.0 message: "If you use this software, please cite it as below." -title: "Multicomponent Flow Code" +title: "Multicomponent Flow Code (MFC)" url: "https://github.com/MFlowCode/MFC" preferred-citation: type: article - title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver" - journal: "Computer Physics Communications" - doi: "10.1016/j.cpc.2020.107396" - volume: 266 - start: 107396 - month: 5 - year: 2021 + title: "MFC 5.0: An exascale many-physics flow solver" + doi: "10.48550/arXiv.2503.07953" + year: 2025 authors: - - given-names: Spencer H. - family-names: Bryngelson - - given-names: Kevin - family-names: Schmidmayer - - given-names: Vedran - family-names: Coralic - - given-names: Jomela C. - family-names: Meng - - given-names: Kazuki - family-names: Maeda - - given-names: Tim - family-names: Colonius + - given-names: Benjamin + family-names: Wilfong + - given-names: Henry + family-names: Le Berre + - given-names: Anand + family-names: Radhakrishnan + - given-names: Ansh + family-names: Gupta + - given-names: Diego + family-names: Vaca-Revelo + - given-names: Dimitrios + family-names: Adam + - given-names: Haocheng + family-names: Yu + - given-names: Hyeoksu + family-names: Lee + - given-names: Jose Rodolfo + family-names: Chreim + - given-names: Mirelys + family-names: Carcana Barbosa + - given-names: Yanjun + family-names: Zhang + - given-names: Esteban + family-names: Cisneros-Garibay + - given-names: Aswin + family-names: Gnanaskandan + - given-names: Mauro + family-names: Rodriguez Jr. + - given-names: Reuben D. + family-names: Budiardja + - given-names: Stephen + family-names: Abbott + - given-names: Tim + family-names: Colonius + - given-names: Spencer H. + family-names: Bryngelson +references: + - type: article + title: "Method for portable, scalable, and performant GPU-accelerated simulation of multiphase compressible flow" + doi: "10.1016/j.cpc.2024.109238" + journal: "Computer Physics Communications" + volume: 302 + start: 109238 + year: 2024 + authors: + - given-names: A. + family-names: Radhakrishnan + - given-names: H. + family-names: Le Berre + - given-names: B. + family-names: Wilfong + - given-names: J.-S. + family-names: Spratt + - given-names: M. + family-names: Rodriguez Jr. + - given-names: T. + family-names: Colonius + - given-names: S. H. + family-names: Bryngelson + - type: article + title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver" + doi: "10.1016/j.cpc.2020.107396" + journal: "Computer Physics Communications" + volume: 266 + start: 107396 + month: 5 + year: 2021 + authors: + - given-names: Spencer H. + family-names: Bryngelson + - given-names: Kevin + family-names: Schmidmayer + - given-names: Vedran + family-names: Coralic + - given-names: Jomela C. + family-names: Meng + - given-names: Kazuki + family-names: Maeda + - given-names: Tim + family-names: Colonius diff --git a/README.md b/README.md index b5d0152979..4cb0ecbf1b 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,43 @@

+

+ + + + + + + + + + + + +

+ +

+ + Star History Chart + +

+ +> **If MFC helps your work, please ⭐ the repo and cite it!** + +### Who uses MFC + +MFC runs at exascale on the world's fastest supercomputers: +- **OLCF Frontier** (>33K AMD MI250X GPUs) +- **LLNL El Capitan** (>43K AMD MI300A APUs) +- **LLNL Tuolumne**, **OLCF Summit**, and many others + +### Try MFC + +| Path | Command | +| --- | --- | +| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click | +| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` | + **Welcome!** MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do). It uses metaprogramming and is short (20K lines) and portable. @@ -35,6 +72,9 @@ MFC is a 2025 Gordon Bell Prize Finalist. + + + @@ -92,7 +132,7 @@ Click <> Code (green button at top right) → Codespaces > ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage. > It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device. > Don't conduct any critical work here! -> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html). +> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/docker.html). You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer! It's rather straightforward. From 8e9611c851902b883c022da85463933a054cfb9a Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Tue, 4 Nov 2025 12:07:03 -0500 Subject: [PATCH 2/5] minor --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4cb0ecbf1b..349bd721c4 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ MFC runs at exascale on the world's fastest supercomputers: - **OLCF Frontier** (>33K AMD MI250X GPUs) - **LLNL El Capitan** (>43K AMD MI300A APUs) -- **LLNL Tuolumne**, **OLCF Summit**, and many others +- **LLNL Tuolumne**, **CSCS Alps**, and many others ### Try MFC @@ -132,7 +132,7 @@ Click <> Code (green button at top right) → Codespaces > ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage. > It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device. > Don't conduct any critical work here! -> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/docker.html). +> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html). You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get you get started using MFC on your local machine, cluster, or supercomputer! It's rather straightforward. From a2c93a1b45f1cc3a407081c45c262dbde71a4243 Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Tue, 4 Nov 2025 12:22:16 -0500 Subject: [PATCH 3/5] Update DOI badge in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 349bd721c4..aafc401a1e 100644 --- a/README.md +++ b/README.md @@ -72,8 +72,8 @@ MFC is a 2025 Gordon Bell Prize Finalist. - - + + From 01a10cd2be8f1da1ac33946819289218483394d6 Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Tue, 4 Nov 2025 12:26:32 -0500 Subject: [PATCH 4/5] Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/config.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0e5c8003ac..9e5f5f8a47 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,3 @@ -blank_issues_enabled: false -contact_links: - - name: Questions & support - url: https://github.com/MFlowCode/MFC/discussions - about: Get help, show results, and discuss ideas - - name: Slack community - url: https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw - about: Join our Slack workspace for real-time discussion From 4d8316b3cac85d628bd96fb41df06fb6baf7930c Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Tue, 4 Nov 2025 12:27:07 -0500 Subject: [PATCH 5/5] Delete .github/ISSUE_TEMPLATE/config.yml --- .github/ISSUE_TEMPLATE/config.yml | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 9e5f5f8a47..0000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - -