update READMEs

ajnonaka · Jan 24, 2024 · dd0fe54 · dd0fe54
1 parent a8c0b4a
commit dd0fe54
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 26 deletions.
diff --git a/ExampleCodes/heFFTe/Basic/README b/ExampleCodes/heFFTe/Basic/README
@@ -11,7 +11,9 @@ OR
 >> mkdir build
 >> cd build
 
+######################
 HOST BUILD
+######################
 
 # NOTE: -DCMAKE_INSTALL_PREFIX can be a different location /path/to/DCMAKE_INSTALL_PREFIX
 
@@ -23,19 +25,17 @@ HOST BUILD
 >> cd /path/to/amrex-tutorials/ExampleCodes/heFFTe/Basic
 >> make -j4 HEFFTE_HOME=/path/to/DCMAKE_INSTALL_PREFIX
 
+######################
 NVIDIA/CUDA BUILD
+######################
 
->> cmake -DCMAKE_BUILD_TYPE=Release \
-   	 -DCMAKE_CXX_STANDARD=17 \
-  	 -DBUILD_SHARED_LIBS=OFF \
-  	 -DCMAKE_INSTALL_PREFIX=. \  # can choose any installation /path/to/heffte
-  	 -DHeffte_ENABLE_FFTW=ON \
-  	 -DHeffte_ENABLE_CUDA=ON \
-  	 -DHeffte_DISABLE_GPU_AWARE_MPI=ON \  # OFF is not working on perlmutter
-  	 ..
+# NOTE: -DCMAKE_INSTALL_PREFIX can be a different location /path/to/DCMAKE_INSTALL_PREFIX
+# NOTE: -DHeffte_DISABLE_GPU_AWARE_MPI=OFF is not working on perlmutter
+
+>> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX=. -DHeffte_ENABLE_FFTW=ON -DHeffte_ENABLE_CUDA=ON -DHeffte_DISABLE_GPU_AWARE_MPI=ON ..
 
 >> make -j4
 >> make install
 
 >> cd /path/to/amrex-tutorials/ExampleCodes/heFFTe/Basic/
->> make -j4 USE_CUDA=TRUE HEFFTE_HOME=/path/to/heffte
+>> make -j4 USE_CUDA=TRUE HEFFTE_HOME=/path/to/DCMAKE_INSTALL_PREFIX
diff --git a/ExampleCodes/heFFTe/Poisson/README b/ExampleCodes/heFFTe/Poisson/README
@@ -11,35 +11,31 @@ OR
 >> mkdir build
 >> cd build
 
+######################
 HOST BUILD
+######################
 
->> cmake -DCMAKE_BUILD_TYPE=Release \
-   	 -DCMAKE_CXX_STANDARD=17 \
-   	 -DBUILD_SHARED_LIBS=OFF \
-  	 -DCMAKE_INSTALL_PREFIX=. \  # can choose any installation /path/to/heffte
-  	 -DHeffte_ENABLE_FFTW=ON \
-  	 -DHeffte_ENABLE_CUDA=OFF \
-  	 ..
+# NOTE: -DCMAKE_INSTALL_PREFIX can be a different location /path/to/DCMAKE_INSTALL_PREFIX
+
+>> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX=. -DHeffte_ENABLE_FFTW=ON -DHeffte_ENABLE_CUDA=OFF ..
 
 >> make -j4
 >> make install
 
 >> cd /path/to/amrex-tutorials/ExampleCodes/heFFTe/Poisson
->> make -j4 HEFFTE_HOME=/path/to/heffte
+>> make -j4 HEFFTE_HOME=/path/to/DCMAKE_INSTALL_PREFIX
 
+######################
 NVIDIA/CUDA BUILD
+######################
+
+# NOTE: -DCMAKE_INSTALL_PREFIX can be a different location /path/to/DCMAKE_INSTALL_PREFIX
+# NOTE: -DHeffte_DISABLE_GPU_AWARE_MPI=OFF is not working on perlmutter
 
->> cmake -DCMAKE_BUILD_TYPE=Release \
-   	 -DCMAKE_CXX_STANDARD=17 \
-  	 -DBUILD_SHARED_LIBS=OFF \
-  	 -DCMAKE_INSTALL_PREFIX=. \  # can choose any installation /path/to/heffte
-  	 -DHeffte_ENABLE_FFTW=ON \
-  	 -DHeffte_ENABLE_CUDA=ON \
-  	 -DHeffte_DISABLE_GPU_AWARE_MPI=ON \  # OFF is not working on perlmutter
-  	 ..
+>> cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX=. -DHeffte_ENABLE_FFTW=ON -DHeffte_ENABLE_CUDA=ON -DHeffte_DISABLE_GPU_AWARE_MPI=ON ..
 
 >> make -j4
 >> make install
 
 >> cd /path/to/amrex-tutorials/ExampleCodes/heFFTe/Poisson/
->> make -j4 USE_CUDA=TRUE HEFFTE_HOME=/path/to/heffte
+>> make -j4 USE_CUDA=TRUE HEFFTE_HOME=/path/to/DCMAKE_INSTALL_PREFIX