Skip to content

Update README.md #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dseyler merged 2 commits into from
Nov 19, 2024
Merged

Update README.md #302

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30eb56a
Update README.md
dseyler Nov 15, 2024
9859873
Merge branch 'SimVascular:main' into fix_readme
dseyler Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# svFSIplus

[![Build Status](https://github.com/SimVascular/svFSIplus/actions/workflows/test.yml/badge.svg)](https://github.com/SimVascular/svFSIplus/actions)
[![Build Status (Ubuntu)](https://github.com/SimVascular/svFSIplus/actions/workflows/test_ubuntu.yml/badge.svg)](https://github.com/SimVascular/svFSIplus/actions)
[![Build Status (macOS)](https://github.com/SimVascular/svFSIplus/actions/workflows/test_macos.yml/badge.svg)](https://github.com/SimVascular/svFSIplus/actions)
[![codecov](https://codecov.io/github/SimVascular/svFSIplus/graph/badge.svg?token=I848DNIHSP)](https://codecov.io/github/SimVascular/svFSIplus)
![Latest Release](https://img.shields.io/github/v/release/SimVascular/svFSIplus?label=latest)
![Platform](https://img.shields.io/badge/platform-macOS%20|%20linux-blue)
Expand Down Expand Up @@ -34,7 +35,7 @@ The [svFSIplus Internal Code Documentation](https://simvascular.github.io/svfsip
<!--- =================================================================================== -->

<h1 id="docker_container"> Docker </h1>
The preferred way to use svFSIplus, is to take advantage of the provided Docker container, which include the latest version of svFSIplus pre-compiled. To use this option, Docker must be installed first. Please refer to [Docker webpage](https://www.docker.com/products/docker-desktop/) to know more about Docker and how to install it on your machine. The following steps describe how to build a Docker image or pull an existent one from DockerHub, and how to run a Docker container. The last section is a brief guide to perform the same steps but in Singularity, since HPC systems usually use Singularity to handle containers.
The preferred way to use svFSIplus on an HPC system, is to take advantage of the provided Docker container, which include the latest version of svFSIplus pre-compiled. To use this option, Docker must be installed first. Please refer to [Docker webpage](https://www.docker.com/products/docker-desktop/) to know more about Docker and how to install it on your machine. The following steps describe how to build a Docker image or pull an existent one from DockerHub, and how to run a Docker container. The last section is a brief guide to perform the same steps but in Singularity, since HPC systems usually use Singularity to handle containers.

## Docker image
A Docker image is a read-only template that may contain dependencies, libraries, and everything needed to run a program. It is like a snapshot of a particular environment.
Expand Down Expand Up @@ -148,7 +149,7 @@ mpirun --mca psec ^munge -n #TotalNumberOfTasks ...
<!--- =================================================================================== -->

<h1 id="building"> Building the svFSIplus Program from Source </h1>
The svFSIplus program can be compiled and linked from the GitHub source using a CMake build process. The build process creates a binary executable file named **svfsiplus**.
The svFSIplus program can be compiled and linked from the GitHub source using a CMake build process. The build process creates a binary executable file named <b>svfsiplus</b>.

## Supported Platforms

Expand Down Expand Up @@ -194,8 +195,8 @@ svFSIplus is built using the following steps
3) Create a build directory and change directories to it

```
mkdir fsiplus-build
cd fsiplus-build
mkdir build
cd build
```

4) Execute the build
Expand All @@ -206,7 +207,7 @@ svFSIplus is built using the following steps
```
This creates the **svfsiplus** binary executable located in
```
fsiplus-build/svFSIplus-build/bin/svfsiplus
build/svFSIplus-build/bin/svfsiplus
```


Expand Down Expand Up @@ -387,4 +388,4 @@ A simulation can be run in parallel on four processors using
```
mpiexec -np 4 svfsiplus fluid3.xml
```
In this case a directory named `4-procs` containing the simulation results output will be created. Results from different processors will be combined into a single file for a given time step.
In this case a directory named `4-procs` containing the simulation results output will be created. Results from different processors will be combined into a single file for a given time step.