Skip to content

Commit e521af1

Browse files
authored
Update README.md (#961)
1 parent f775131 commit e521af1

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
</p>
66

77
<p align="center">
8-
<a href="http://dx.doi.org/10.1016/j.cpc.2020.107396" target="_blank">
9-
<img src="https://zenodo.org/badge/doi/10.1016/j.cpc.2020.107396.svg" />
10-
</a>
118
<a href="https://github.com/MFlowCode/MFC/actions">
12-
<img src="https://github.com/MFlowCode/MFC/actions/workflows/test.yml/badge.svg" />
9+
<img src="https://img.shields.io/github/actions/workflow/status/mflowcode/mfc/test.yml?style=flat&label=Tests&color=slateblue%09"/>
10+
</a>
11+
<a href="https://github.com/MFlowCode/MFC/blob/master/.github/CONTRIBUTING.md">
12+
<img src="https://img.shields.io/github/contributors-anon/mflowcode/mfc?style=flat&color=darkslategrey%09" />
1313
</a>
1414
<a href="https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw">
1515
<img src="https://img.shields.io/badge/slack-MFC-purple.svg?logo=slack" />
1616
</a>
1717
<a href="https://lbesson.mit-license.org/">
18-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" />
18+
<img src="https://img.shields.io/badge/License-MIT-crimson.svg" />
1919
</a>
2020
<a href="https://codecov.io/github/MFlowCode/MFC" target="_blank">
2121
<img src="https://codecov.io/github/MFlowCode/MFC/graph/badge.svg?token=8SY043QND4">
@@ -25,12 +25,35 @@
2525
</a>
2626
</p>
2727

28-
Welcome to the home of MFC!
29-
MFC simulates compressible multi-component and multi-phase flows, [amongst other things](#what-else-can-this-thing-do).
30-
MFC is written in Fortran and uses metaprogramming to keep the code short (about 20K lines).
28+
**Welcome!**
29+
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
30+
It uses metaprogramming to stay short and portable (~20K lines).
31+
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).
32+
33+
<p align="center">
34+
<a href="https://doi.org/10.48550/arXiv.2503.07953" target="_blank">
35+
<img src="https://img.shields.io/badge/DOI-10.48550/arXiv.2503.07953-thistle.svg"/>
36+
</a>
37+
<a href="https://github.com/MFlowCode/MFC/stargazers" target="_blank">
38+
<img src="https://img.shields.io/github/stars/MFlowCode/MFC?style=flat&color=maroon"/>
39+
</a>
40+
41+
</br>
42+
Is MFC useful for you? Consider citing it or giving a star!
43+
</p>
44+
45+
```bibtex
46+
@article{Wilfong_2025,
47+
author = {Wilfong, Benjamin and {Le Berre}, Henry and Radhakrishnan, Anand and Gupta, Ansh and Vaca-Revelo, Diego and Adam, Dimitrios and Yu, Haocheng and Lee, Hyeoksu and Chreim, Jose Rodolfo and {Carcana Barbosa}, Mirelys and Zhang, Yanjun and Cisneros-Garibay, Esteban and Gnanaskandan, Aswin and {Rodriguez Jr.}, Mauro and Budiardja, Reuben D. and Abbott, Stephen and Colonius, Tim and Bryngelson, Spencer H.},
48+
title = {{MFC 5.0: A}n exascale many-physics flow solver},
49+
journal = {arXiv preprint arXiv:2503.07953},
50+
year = {2025},
51+
doi = {10.48550/arXiv.2503.07953}
52+
}
53+
```
3154

3255
MFC is used on the latest leadership-class supercomputers.
33-
It scales <b>ideally to exascale</b>; [tens of thousands of GPUs on NVIDIA- and AMD-GPU machines](#is-this-really-exascale) on Oak Ridge Summit and Frontier.
56+
It scales <b>ideally to exascale</b>; [tens of thousands of GPUs on NVIDIA- and AMD-GPU machines](#is-this-really-exascale) on Oak Ridge Frontier, LLNL El Capitan, CSCS Alps, among others.
3457
MFC is a SPEChpc benchmark candidate, part of the JSC JUPITER Early Access Program, and used OLCF Frontier and LLNL El Capitan early access systems.
3558

3659
Get in touch with <a href="mailto:[email protected]">Spencer</a> if you have questions!

0 commit comments

Comments
 (0)