Skip to content

Commit 7982c58

Browse files
docs: Update README and CITATION.cff, add issue templates (#1022)
Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
1 parent ee4e831 commit 7982c58

File tree

3 files changed

+150
-20
lines changed

3 files changed

+150
-20
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Propose an enhancement to MFC
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
### Problem it solves
10+
<!-- What limitation or use case does this address? -->
11+
12+
### Proposed solution
13+
<!-- Describe the change and where it integrates (modules, scripts, docs). -->
14+
15+
### Alternatives
16+
<!-- Any other approaches considered -->
17+
18+
### Additional context
19+
<!-- Links, references, mockups, examples -->
20+
21+
22+
23+
24+
25+
26+

CITATION.cff

Lines changed: 84 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,91 @@
44

55
cff-version: 1.2.0
66
message: "If you use this software, please cite it as below."
7-
title: "Multicomponent Flow Code"
7+
title: "Multicomponent Flow Code (MFC)"
88
url: "https://github.com/MFlowCode/MFC"
99
preferred-citation:
1010
type: article
11-
title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver"
12-
journal: "Computer Physics Communications"
13-
doi: "10.1016/j.cpc.2020.107396"
14-
volume: 266
15-
start: 107396
16-
month: 5
17-
year: 2021
11+
title: "MFC 5.0: An exascale many-physics flow solver"
12+
doi: "10.48550/arXiv.2503.07953"
13+
year: 2025
1814
authors:
19-
- given-names: Spencer H.
20-
family-names: Bryngelson
21-
- given-names: Kevin
22-
family-names: Schmidmayer
23-
- given-names: Vedran
24-
family-names: Coralic
25-
- given-names: Jomela C.
26-
family-names: Meng
27-
- given-names: Kazuki
28-
family-names: Maeda
29-
- given-names: Tim
30-
family-names: Colonius
15+
- given-names: Benjamin
16+
family-names: Wilfong
17+
- given-names: Henry
18+
family-names: Le Berre
19+
- given-names: Anand
20+
family-names: Radhakrishnan
21+
- given-names: Ansh
22+
family-names: Gupta
23+
- given-names: Diego
24+
family-names: Vaca-Revelo
25+
- given-names: Dimitrios
26+
family-names: Adam
27+
- given-names: Haocheng
28+
family-names: Yu
29+
- given-names: Hyeoksu
30+
family-names: Lee
31+
- given-names: Jose Rodolfo
32+
family-names: Chreim
33+
- given-names: Mirelys
34+
family-names: Carcana Barbosa
35+
- given-names: Yanjun
36+
family-names: Zhang
37+
- given-names: Esteban
38+
family-names: Cisneros-Garibay
39+
- given-names: Aswin
40+
family-names: Gnanaskandan
41+
- given-names: Mauro
42+
family-names: Rodriguez Jr.
43+
- given-names: Reuben D.
44+
family-names: Budiardja
45+
- given-names: Stephen
46+
family-names: Abbott
47+
- given-names: Tim
48+
family-names: Colonius
49+
- given-names: Spencer H.
50+
family-names: Bryngelson
51+
references:
52+
- type: article
53+
title: "Method for portable, scalable, and performant GPU-accelerated simulation of multiphase compressible flow"
54+
doi: "10.1016/j.cpc.2024.109238"
55+
journal: "Computer Physics Communications"
56+
volume: 302
57+
start: 109238
58+
year: 2024
59+
authors:
60+
- given-names: A.
61+
family-names: Radhakrishnan
62+
- given-names: H.
63+
family-names: Le Berre
64+
- given-names: B.
65+
family-names: Wilfong
66+
- given-names: J.-S.
67+
family-names: Spratt
68+
- given-names: M.
69+
family-names: Rodriguez Jr.
70+
- given-names: T.
71+
family-names: Colonius
72+
- given-names: S. H.
73+
family-names: Bryngelson
74+
- type: article
75+
title: "MFC: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver"
76+
doi: "10.1016/j.cpc.2020.107396"
77+
journal: "Computer Physics Communications"
78+
volume: 266
79+
start: 107396
80+
month: 5
81+
year: 2021
82+
authors:
83+
- given-names: Spencer H.
84+
family-names: Bryngelson
85+
- given-names: Kevin
86+
family-names: Schmidmayer
87+
- given-names: Vedran
88+
family-names: Coralic
89+
- given-names: Jomela C.
90+
family-names: Meng
91+
- given-names: Kazuki
92+
family-names: Maeda
93+
- given-names: Tim
94+
family-names: Colonius

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,43 @@
2525
</a>
2626
</p>
2727

28+
<p align="center">
29+
<a href="https://mflowcode.github.io/">
30+
<img src="https://img.shields.io/badge/docs-mflowcode.github.io-blue" />
31+
</a>
32+
<a href="https://github.com/MFlowCode/MFC/discussions">
33+
<img src="https://img.shields.io/badge/discussions-join-brightgreen" />
34+
</a>
35+
<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC">
36+
<img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
37+
</a>
38+
<a href="https://github.com/MFlowCode/MFC/releases">
39+
<img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release&sort=semver" />
40+
</a>
41+
</p>
42+
43+
<p align="center">
44+
<a href="https://star-history.com/#MFlowCode/MFC&Date">
45+
<img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date" alt="Star History Chart" width="600"/>
46+
</a>
47+
</p>
48+
49+
> **If MFC helps your work, please ⭐ the repo and cite it!**
50+
51+
### Who uses MFC
52+
53+
MFC runs at exascale on the world's fastest supercomputers:
54+
- **OLCF Frontier** (>33K AMD MI250X GPUs)
55+
- **LLNL El Capitan** (>43K AMD MI300A APUs)
56+
- **LLNL Tuolumne**, **CSCS Alps**, and many others
57+
58+
### Try MFC
59+
60+
| Path | Command |
61+
| --- | --- |
62+
| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click |
63+
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |
64+
2865
**Welcome!**
2966
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
3067
It uses metaprogramming and is short (20K lines) and portable.
@@ -35,6 +72,9 @@ MFC is a 2025 Gordon Bell Prize Finalist.
3572
<a href="https://doi.org/10.48550/arXiv.2503.07953" target="_blank">
3673
<img src="https://img.shields.io/badge/DOI-10.48550/arXiv.2503.07953-thistle.svg"/>
3774
</a>
75+
<a href="https://doi.org/10.5281/zenodo.17049757" target="_blank">
76+
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17049757.svg"/>
77+
</a>
3878
<a href="https://github.com/MFlowCode/MFC/stargazers" target="_blank">
3979
<img src="https://img.shields.io/github/stars/MFlowCode/MFC?style=flat&color=maroon"/>
4080
</a>

0 commit comments

Comments
 (0)