From 36d989fc56168ec0abf56b7013ab0d3f9de7f9c2 Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Fri, 22 Mar 2024 18:27:49 -0400 Subject: [PATCH] Update getting-started.md (#378) --- README.md | 14 ++++++++++---- docs/documentation/getting-started.md | 5 +++-- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9fde585112..248129816a 100644 --- a/README.md +++ b/README.md @@ -50,20 +50,26 @@ Another example is the high-Mach flow over an airfoil, shown below. You can navigate [to this webpage](https://mflowcode.github.io/documentation/md_getting-started.html) to get started using MFC! It's rather straightforward. - We'll give a brief intro. here for MacOS. Using [brew](https://brew.sh), install MFC's modest set of dependencies: ```console -brew install wget make python make cmake coreutils gcc mpich +brew install wget python cmake gcc@13 mpich ``` You're now ready to build and test MFC! -Clone it to a convenient directory via +Put it to a convenient directory via ```console git clone https://github.com/mflowcode/MFC.git cd MFC ``` -then build and test! +and make sure MFC knows what compilers to use by putting the following in your `~/.profile` +```console +export CC=gcc-13 +export CXX=g++-13 +export FC=gfortran-13 +``` +and source that file, build, and test! ```console +source ~/.profile ./mfc.sh build -j 8 ./mfc.sh test -j 8 ``` diff --git a/docs/documentation/getting-started.md b/docs/documentation/getting-started.md index f813d709b7..ee7c6f0aa0 100644 --- a/docs/documentation/getting-started.md +++ b/docs/documentation/getting-started.md @@ -30,7 +30,8 @@ sudo apt update sudo apt upgrade sudo apt install tar wget make cmake gcc g++ \ python3 python3-dev \ - "openmpi-*" libopenmpi-dev + "openmpi-*" libopenmpi-dev \ + python3-venv ``` - **Via [Pacman](https://wiki.archlinux.org/title/pacman):** @@ -120,7 +121,7 @@ export FC=gfortran-$MFC_GCC_VER **Close the open editor and terminal window**. Open a **new terminal** window before executing the commands below. ```console -brew install wget make python make cmake coreutils gcc@$MFC_GCC_VER mpich +brew install wget python cmake gcc@$MFC_GCC_VER mpich ``` They will download the dependencies MFC requires to build itself.