You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Restructure README: lead with impact, add Why MFC, fix broken links
- Add tagline and hero blockquote (Gordon Bell, 200T grid points, exascale)
- Promote shock-droplet image to hero position
- Add "Why MFC?" section with 6 key differentiators
- Streamline "Try MFC" with direct Codespace link and first-simulation command
- Remove redundant Getting Started section (Codespaces detail, macOS from-source)
- Deduplicate citation block and star CTA (each appeared twice)
- Move star history chart to bottom
- Fix 3 broken doc links: md_examples, md_running, md_getting-started
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
> **2025 Gordon Bell Prize Finalist** - MFC simulates compressible multi-phase flows at exascale, using [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming in ~40K lines of Fortran. It conducted the [largest known public CFD simulation](https://arxiv.org/abs/2505.07392) at **200 trillion grid points** and 1 quadrillion degrees of freedom, scaling ideally to >43K AMD APUs on [El Capitan](https://hpc.llnl.gov/hardware/compute-platforms/el-capitan) and >33K AMD GPUs on [Frontier](https://www.olcf.ornl.gov/frontier/).
<img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date&theme=dark" alt="Star History Chart" width="600"/>
53
-
</picture>
54
-
</a>
51
+
<img src="docs/res/shockdrop.png" alt="Shock-droplet interaction simulated with MFC" width="700"/>
55
52
</p>
56
53
57
-
> **If MFC helps your work, please ⭐ the repo and cite it!**
54
+
## Why MFC?
58
55
59
-
### Who uses MFC
56
+
-**Exascale GPU performance** - Ideal weak scaling to 43K+ GPUs. Near compute-roofline behavior. [Compile-time case optimization](https://mflowcode.github.io/documentation/running.html) for up to 10x speedup.
57
+
-**Compact codebase** - ~40K lines of Fortran with [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming. Small enough to read and modify; powerful enough for [Gordon Bell](https://awards.acm.org/bell).
58
+
-**Native multi-phase** - 4, 5, and 6-equation models, phase change, surface tension, bubble dynamics, and Euler-Lagrange particle tracking, all built in.
59
+
-**Portable** - NVIDIA and AMD GPUs, CPUs, laptops to exascale. Docker, Codespaces, Homebrew, and [16+ HPC system templates](https://mflowcode.github.io/documentation/running.html).
60
+
-**Tested** - 500+ regression tests per PR with line-level [coverage](https://app.codecov.io/gh/MFlowCode/MFC) across GNU, Intel, Cray, and NVIDIA compilers.
61
+
-**Truly open** - MIT license, active [Slack](https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw), and responsive development team.
60
62
61
-
MFC runs at exascale on the world's fastest supercomputers:
62
-
-**OLCF Frontier** (>33K AMD MI250X GPUs)
63
-
-**LLNL El Capitan** (>43K AMD MI300A APUs)
64
-
-**LLNL Tuolumne**, **CSCS Alps**, and many others
63
+
> If MFC is useful to your work, please ⭐ star the repo and [cite it](#citation)!
65
64
66
-
###Try MFC
65
+
## Try MFC
67
66
68
67
| Path | Command |
69
68
| --- | --- |
70
-
|**Codespaces** (fastest) 💨 |Click the "Codespaces" badge above to launch in 1 click|
69
+
|**Codespaces** (fastest) 💨 |[Open a Codespace](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC) - pre-built, zero install|
71
70
|**Docker** 🐳 |`docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu`|
MFC simulates compressible multi-phase flows, [among other things](#what-else-can-this-thing-do).
77
-
It uses metaprogramming and is short (~40K lines of Fortran) and portable.
78
-
MFC conducted the largest known CFD simulation at <ahref="https://arxiv.org/abs/2505.07392"target="_blank">200 trillion grid points</a>, and 1 quadrillion degrees of freedom (as of September 2025).
Author = {Benjamin Wilfong and Henry {Le Berre} and Anand Radhakrishnan and Ansh Gupta and Daniel J. Vickers and Diego Vaca-Revelo and Dimitrios Adam and Haocheng Yu and Hyeoksu Lee and Jose Rodolfo Chreim and Mirelys {Carcana Barbosa} and Yanjun Zhang and Esteban Cisneros-Garibay and Aswin Gnanaskandan and Mauro {Rodriguez Jr.} and Reuben D. Budiardja and Stephen Abbott and Tim Colonius and Spencer H. Bryngelson},
99
-
Title = {{MFC 5.0: A}n exascale many-physics flow solver},
100
-
journal = {Computer Physics Communications},
101
-
year = {2026},
102
-
volume = {322},
103
-
pages = {110055},
104
-
doi = {10.1016/j.cpc.2026.110055},
105
-
}
74
+
Your first simulation:
75
+
```bash
76
+
./mfc.sh run examples/3d_shockdroplet/case.py -n $(nproc)
106
77
```
78
+
Visualize the output in `examples/3d_shockdroplet/silo_hdf5/` with ParaView, VisIt, or your favorite tool.
79
+
For detailed build instructions (Linux, macOS, Windows/WSL, HPC clusters), see the [Getting Started guide](https://mflowcode.github.io/documentation/getting-started.html).
107
80
108
-
MFC is used on the latest leadership-class supercomputers.
109
-
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.
110
-
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.
111
-
112
81
Get in touch with <ahref="mailto:shb@gatech.edu">Spencer</a> if you have questions!
113
82
We have an [active Slack channel](https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw) and development team.
114
83
MFC has high- and low-level documentation, visualizations, and more on [its website](https://mflowcode.github.io/).
115
84
116
-
## An example
117
-
118
-
We keep many examples.
119
-
Here are some of them!
120
-
MFC can execute high-fidelity simulations of shock-droplet interaction (see `examples/3d_shockdroplet`)
<img src="docs/res/orifice.png" alt="Acoustic wave through orifice" width="700"/><br/>
136
98
</p>
137
99
138
-
139
-
## Getting started
140
-
141
-
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!
For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands.
152
-
Click <kbd> <> Code</kbd> (green button at top right) → <kbd>Codespaces</kbd> (right tab) → <kbd>+</kbd> (create a codespace).
153
-
154
-
Alternatively, run MFC directly with Docker on your local machine:
155
-
```bash
156
-
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
157
-
```
158
-
Once inside the container, navigate to `/opt/MFC` to access MFC and run examples.
159
-
160
-
> ****Note:**** Codespaces is a free service with a monthly quota of compute time and storage usage.
161
-
> It is recommended for testing commands, troubleshooting, and running simple case files without installing dependencies or building MFC on your device.
162
-
> Don't conduct any critical work here!
163
-
> To learn more, please see [how Docker & Containers work](https://mflowcode.github.io/documentation/md_docker.html).
! [ -z"${BOOST_INCLUDE+x}" ] &&echo'Environment is ready!'||echo'Error: $BOOST_INCLUDE is unset. Please adjust the previous commands to fit with your environment.'
Run `./mfc.sh <command> --help` for detailed options, or see the [full documentation](https://mflowcode.github.io/documentation/index.html). Tab completion for bash and zsh is auto-installed after you have run `./mfc.sh generate` (or any non-`init` command) at least once. Play with the examples in `examples/` ([showcased here](https://mflowcode.github.io/documentation/md_examples.html)).
112
+
Run `./mfc.sh <command> --help` for detailed options, or see the [full documentation](https://mflowcode.github.io/documentation/index.html). Tab completion for bash and zsh is auto-installed after you have run `./mfc.sh generate` (or any non-`init` command) at least once. Play with the examples in `examples/` ([showcased here](https://mflowcode.github.io/documentation/examples.html)).
221
113
222
114
The shock-droplet interaction case above was run via
223
115
```shell
224
-
./mfc.sh run -n $(nproc) ./examples/3d_shockdroplet/case.py
116
+
./mfc.sh run -n $(nproc) ./examples/3d_shockdroplet/case.py
225
117
```
226
118
where `$(nproc)` is the number of cores the example will run on (and the number of physical cores on your CPU device).
227
119
You can visualize the output data in `examples/3d_shockdroplet/silo_hdf5` via Paraview, Visit, or your favorite software.
@@ -231,6 +123,7 @@ You can visualize the output data in `examples/3d_shockdroplet/silo_hdf5` via Pa
231
123
[OLCF Frontier](https://www.olcf.ornl.gov/frontier/) is the first exascale supercomputer.
232
124
The weak scaling of MFC on this machine shows near-ideal utilization.
233
125
We also scale ideally to >98% of LLNL El Capitan.
126
+
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.
Author = {Benjamin Wilfong and Henry {Le Berre} and Anand Radhakrishnan and Ansh Gupta and Daniel J. Vickers and Diego Vaca-Revelo and Dimitrios Adam and Haocheng Yu and Hyeoksu Lee and Jose Rodolfo Chreim and Mirelys {Carcana Barbosa} and Yanjun Zhang and Esteban Cisneros-Garibay and Aswin Gnanaskandan and Mauro {Rodriguez Jr.} and Reuben D. Budiardja and Stephen Abbott and Tim Colonius and Spencer H. Bryngelson},
@@ -353,7 +258,7 @@ The original open-source release of MFC is ref. 3, which should be cited for pro
353
258
```
354
259
355
260
## License
356
-
261
+
357
262
Copyright 2021 Spencer Bryngelson and Tim Colonius.
358
263
MFC is under the MIT license (see [LICENSE](LICENSE) for full text).
359
264
@@ -367,3 +272,15 @@ MFC computations have used many supercomputing systems. A partial list is below
367
272
* NCSA Delta and DeltaAI, PSC Bridges(1/2), SDSC Comet and Expanse, Purdue Anvil, TACC Stampede(1-3), and TAMU ACES via ACCESS-CI allocations from Bryngelson, Colonius, Rodriguez, and more.
368
273
* DOD systems Blueback, Onyx, Carpenter, Nautilus, and Narwhal via the DOD HPCMP program.
369
274
* Sandia National Labs systems Doom and Attaway, and testbed systems Weaver and Vortex.
0 commit comments