From 599ba9b5106c988feac978bd8b332167d350d6f2 Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Sat, 15 Nov 2025 07:54:48 -0600 Subject: [PATCH] readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 27bd184f5..bd1d2d34c 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ MFC runs at exascale on the world's fastest supercomputers: | Path | Command | | --- | --- | | **Codespaces** (fastest) 💨 | Click the "Codespaces" badge above to launch in 1 click | +| **Docker** 🐳 | `docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu` | | **Homebrew** (macOS) 🍺 | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` | | **Local build** 💻 | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` | @@ -140,6 +141,12 @@ Some examples are below. For a _very_ quick start, open a GitHub Codespace to load a pre-configured Docker container and familiarize yourself with MFC commands. Click <> Code (green button at top right) → Codespaces (right tab) → + (create a codespace). +Alternatively, run MFC directly with Docker on your local machine: +```bash +docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu +``` +Once inside the container, navigate to `/opt/MFC` to access MFC and run examples. + > ****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!