From ccb7a6dd41c2d60932f0cf07aa159e29a620e434 Mon Sep 17 00:00:00 2001 From: PhasicFlow <113092888+PhasicFlow@users.noreply.github.com> Date: Thu, 27 Mar 2025 02:50:30 +0330 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2dc2059d..dee37865 100644 --- a/README.md +++ b/README.md @@ -17,26 +17,22 @@ Ongoing development includes the integration of MPI-based parallelization with d 5. **Hybrid Parallelism:** MPI + OpenMP. 6. **Multi-GPU Parallelism:** MPI + CUDA. -# **Build and Installation** +## **Build and Installation** PhasicFlow can be compiled for both CPU and GPU execution. * **Current Development (v-1.0):** Comprehensive build instructions are available [here](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-build-PhasicFlow%E2%80%90v%E2%80%901.0). * **Latest Release (v-0.1):** Detailed build instructions are available [here](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-Build-PhasicFlow). -# **Comprehensive Documentation** +## **Comprehensive Documentation** In-depth documentation, including code structure, features, and usage guidelines, is accessible via the [online documentation portal](https://phasicflow.github.io/phasicFlow/). -## **Tutorials and Examples** +### **Tutorials and Examples** Practical examples and simulation setups are provided in the [tutorials directory](./tutorials). For detailed explanations and step-by-step guides, please refer to the [tutorial section on the PhasicFlow Wiki](https://github.com/PhasicFlow/phasicFlow/wiki/Tutorials). -# **PhasicFlowPlus: Coupled CFD-DEM Simulations** - -PhasicFlowPlus is an extension of PhasicFlow that facilitates the simulation of particle-fluid systems using resolved and unresolved CFD-DEM methods. The repository for PhasicFlowPlus can be found [here](https://github.com/PhasicFlow/PhasicFlowPlus). - -# Contributing to PhasicFlow +## Contributing to PhasicFlow We welcome contributions to PhasicFlow! Whether you're a developer or a new user, there are many ways to get involved. Here's how you can help: 1. Bug Reports 2. Suggestions for better user experience @@ -46,7 +42,11 @@ We welcome contributions to PhasicFlow! Whether you're a developer or a new user For more details on how you can contribute to PhasicFlow see [this page](https://github.com/PhasicFlow/phasicFlow/wiki/How-to-contribute-to-PhasicFlow). -# How to cite PhasicFlow? +## **PhasicFlowPlus: Coupled CFD-DEM Simulations** + +PhasicFlowPlus is an extension of PhasicFlow that facilitates the simulation of particle-fluid systems using resolved and unresolved CFD-DEM methods. The repository for PhasicFlowPlus can be found [here](https://github.com/PhasicFlow/PhasicFlowPlus). + +## How to cite PhasicFlow? If you are using PhasicFlow in your research or industrial work, cite the following [article](https://www.sciencedirect.com/science/article/pii/S0010465523001662): @@ -67,7 +67,8 @@ If you are using PhasicFlow in your research or industrial work, cite the follow } ``` -# **Dependencies** + +## **Dependencies** PhasicFlow relies on the following external libraries: