diff --git a/README.md b/README.md index d24fa660febb4c98b4148a4065b7b4f04187966b..e762a1fafb43cb0657a25c17ee7f9df770d4f600 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,21 @@ VirtualFluids (VF) is a research code developed at the Institute for Computational Modeling in Civil Engineering (iRMB). The code is a Computational Fluid Dynamics (CFD) solver based on the Lattice Boltzmann Method (LBM) for turbulent, thermal, multiphase and multicomponent flow problems as well as for multi-field problems such as Fluid-Structure-interaction including distributed pre- and postprocessing capabilities for simulations with more than 100 billion degrees of freedom. ## Getting Start -### Suported Platforms -VirtualFluids has been used on a variety of platforms: +VirtualFluids is mainly supported on these two platforms: - Linux - - Mac OS X - Windows - - Cygwin + +VirtualFluids can also be build and used in a Docker image. An ubuntu development environment is located in the [container registry](https://git.rz.tu-bs.de/irmb/virtualfluids/container_registry). +An extensive guide about the usage and development in VirtualFluids with docker can be found [here](https://git.rz.tu-bs.de/irmb/virtualfluids/-/wikis/Getting-Start-with-the-development-of-VirtualFluids). + + +The following is a brief explanation of how to use it without Docker: ### Software Requirements - [CMake](https://cmake.org/) (minimum version 3.15) - C++ compiler with C++14 support - - [Paraview](https://www.paraview.org/) (most recent version) + - [Paraview](https://www.paraview.org/) for visualizations (most recent version) + with usage of the GPU: - CUDA [developer.nvidia.com/cuda-zone](https://developer.nvidia.com/cuda-zone): @@ -22,13 +26,9 @@ with usage of the GPU: * Recommended Compute Capability 6.0, because of atomics for double precision floating point data (GKS only) -### Contributing -To contribute to VirtualFluids please follow these [instructions](CONTRIBUTING.md). - ### Build VirtualFluids ```shell -$ mkdir build -$ cd build +$ mkdir build && cd build ``` Pass the relevant [options](#options) to cmake. E.g. for the CPU part: @@ -55,7 +55,8 @@ The CPU part generates a set of multiple output directories in the prescribed ou A GPU computation generates a the time series of output files directly in the output path. In Paraview these time series can be read directly. - +## Contributing +To contribute to VirtualFluids please follow these [instructions](CONTRIBUTING.md). ## Documentation The doxygen generated documentation can be found [here](https://irmb.gitlab-pages.rz.tu-bs.de/VirtualFluids_dev).