From fa40fcbe152a8cf42a5e0d4af85a8aee1acdef43 Mon Sep 17 00:00:00 2001 From: Hamidreza Norouzi Date: Sun, 28 Aug 2022 01:26:49 -0700 Subject: [PATCH] branch test --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 49e14d10..7e18dec1 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ phasicFlow is a parallel C++ code for performing DEM simulations. It can run on # Requirements -## Compilers +### Compilers phasicFlow should work with every gnu compiler that implements C++17 standards. For now, it is tested on Ubuntu distribution of linux operating systems. If the minimum requirements are met, there should not be any problem with compiling the code. However, there are always compiler bugs from one version to another that may need you extra attempts for upgrading to newer versions or downgrading to prior versions of the compiler. * for CPU builds: It requires gcc-6.x or higher. * for GPU (CUDA-enabled): NVCC-10.x or higher. -## Required packages +### Required packages phasicFlow uses [Kokkos]( https://github.com/kokkos/kokkos) as the backend for parallelization. So, you need to have the code in the local machine alongside phasicFlow. The make system is adjusted in a way so you do not need to compile Kokkos separately and the required source code files from Kokkos are compiled alongside the phasicFlow. -## CMake +### CMake You also need to have CMake installed on your computer. At the moment CMake-3.22 or higher is needed. # How to build? @@ -25,7 +25,7 @@ phasicFlow uses CMake as the build system. you need to have CMake-3.22 or higher ### build for parallel execution on CUDA-enabled GPUs # How to use phasicFlow? - + # Extentions in future ### parallelization * Extending the code for using OpenMPTarget backend to include more GPUs for off-loading the computations.