Skip to content

Commit 50542a5

Browse files
authored
readme updates (#579)
1 parent e12a666 commit 50542a5

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424

2525
Welcome to the home of MFC!
2626
MFC simulates compressible multi-component and multi-phase flows, [amongst other things](#what-else-can-this-thing-do).
27-
MFC is written in Fortran and makes use of metaprogramming to keep the code short (about 20K lines).
27+
MFC is written in Fortran and uses metaprogramming to keep the code short (about 20K lines).
2828

2929
MFC is used on the latest leadership-class supercomputers.
3030
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.
31-
MFC is a SPEChpc benchmark candidate, part of the JSC JUPITER Early Access Program, and made use of OLCF Frontier and LLNL El Capitan early access systems.
31+
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.
3232

3333
Get in touch with <a href="mailto:[email protected]">Spencer</a> if you have questions!
3434
We have an [active Slack channel](https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw) and development team.
@@ -56,7 +56,7 @@ Another example is the high-Mach flow over an airfoil, shown below.
5656
You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get started using MFC!
5757
It's rather straightforward.
5858
We'll give a brief intro. here for MacOS.
59-
Using [brew](https://brew.sh), install MFC's modest set of dependencies:
59+
Using [brew](https://brew.sh), install MFC's dependencies:
6060
```shell
6161
brew install wget python cmake gcc@14 mpich
6262
```
@@ -82,15 +82,15 @@ You can learn more about MFC's capabilities [via its documentation](https://mflo
8282

8383
The shock-droplet interaction case above was run via
8484
```shell
85-
./mfc.sh run ./examples/3d_shockdroplet/case.py -n 8
85+
./mfc.sh run -n $(nproc) ./examples/3d_shockdroplet/case.py
8686
```
8787
where `8` is the number of cores the example will run on.
88-
You can visualize the output data in `examples/3d_shockdroplet/silo_hdf5` via Paraview, Visit, or your other favorite software.
88+
You can visualize the output data in `examples/3d_shockdroplet/silo_hdf5` via Paraview, Visit, or your favorite software.
8989

9090
## Is this _really_ exascale?
9191

9292
[OLCF Frontier](https://www.olcf.ornl.gov/frontier/) is the first exascale supercomputer.
93-
The weak scaling of MFC on this machine is below, showing near-ideal utilization.
93+
The weak scaling of MFC on this machine shows near-ideal utilization.
9494

9595
<p align="center">
9696
<img src="docs/res/scaling.png" alt="Scaling" width="400"/>
@@ -158,7 +158,7 @@ They are organized below. Just click the drop-downs!
158158
* [Fypp](https://fypp.readthedocs.io/en/stable/fypp.html) metaprogramming for code readability, performance, and portability
159159
* Continuous Integration (CI)
160160
* \>100 Regression tests with each PR.
161-
* Performed with GNU, Intel, and NVIDIA compilers on NVIDIA and AMD GPUs.
161+
* Performed with GNU (GCC), Intel, Cray (CCE), and NVIDIA (NVHPC) compilers on NVIDIA and AMD GPUs.
162162
* Line-level test coverage reports via [Codecov](https://app.codecov.io/gh/MFlowCode/MFC) and `gcov`
163163
* Benchmarking to avoid performance regressions and identify speed-ups
164164
* Continuous Deployment (CD) of [website](https://mflowcode.github.io) and [API documentation](https://mflowcode.github.io/documentation/index.html)
@@ -201,7 +201,7 @@ If you use MFC, consider citing it as:
201201

202202
## License
203203

204-
Copyright 2021-2024 Spencer Bryngelson and Tim Colonius.
204+
Copyright 2021 Spencer Bryngelson and Tim Colonius.
205205
MFC is under the MIT license (see [LICENSE](LICENSE) for full text).
206206

207207
## Acknowledgements
@@ -210,6 +210,7 @@ Multiple federal sponsors have supported MFC development, including the US Depar
210210

211211
MFC computations have used many supercomputing systems. A partial list is below
212212
* OLCF Frontier and Summit, and testbed systems Wombat, Crusher, and Spock (allocation CFD154, PI Bryngelson)
213+
* LLNL Lassen and El Capitan testbed system, Tioga
213214
* PSC Bridges(1/2), NCSA Delta, SDSC Comet and Expanse, Purdue Anvil, TACC Stampede(1-3), and TAMU ACES via ACCESS-CI (allocations TG-CTS120005 (PI Colonius) and TG-PHY210084 (PI Bryngelson))
214215
* DOD systems Onyx, Carpenter, and Nautilus via the DOD HPCMP program
215216
* Sandia National Labs systems Doom and Attaway and testbed systems Weaver and Vortex

0 commit comments

Comments
 (0)