xfygogo
/
phasicFlow
mirror of https://github.com/PhasicFlow/phasicFlow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

branch test

This commit is contained in:
Hamidreza Norouzi 2022-08-28 01:26:49 -07:00
parent c378ea9921
commit fa40fcbe15
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,15 +4,15 @@ phasicFlow is a parallel C++ code for performing DEM simulations. It can run on
# Requirements # 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. 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 CPU builds: It requires gcc-6.x or higher.
* for GPU (CUDA-enabled): NVCC-10.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. 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. You also need to have CMake installed on your computer. At the moment CMake-3.22 or higher is needed.
# How to build? # 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 ### build for parallel execution on CUDA-enabled GPUs
# How to use phasicFlow? # How to use phasicFlow?
# Extentions in future # Extentions in future
### parallelization ### parallelization
* Extending the code for using OpenMPTarget backend to include more GPUs for off-loading the computations. * Extending the code for using OpenMPTarget backend to include more GPUs for off-loading the computations.