Skip to content

Commit

Permalink
Added missing information regarding MPI in combination with AppImage
Browse files Browse the repository at this point in the history
  • Loading branch information
scopplestone committed Jun 8, 2023
1 parent c5eed66 commit 7eddfbf
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ support the project by citing our publications given in [REFERENCE.md](REFERENCE

The documentation of PICLas can be found in the [User Guide](https://piclas.readthedocs.io/), where the installation procedure is
described in [Chapter 2](https://piclas.readthedocs.io/en/latest/userguide/installation.html).
Pre-compiled executables for Linux can directly be downloaded as AppImage containers from the
[PICLas release tag assets](https://github.com/piclas-framework/piclas/releases).
Pre-compiled executables (that only require pre-installed MPI for parallel execution) for Linux can directly be downloaded as
AppImage containers from the [PICLas release tag assets](https://github.com/piclas-framework/piclas/releases).

## Regression Testing

Expand Down
2 changes: 2 additions & 0 deletions docs/documentation/userguide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ In that case, you can jump directly to the description of the download and insta
## AppImage executable download

PICLas and its tools can be installed on a Linux machine without the need of compiling the source code.
The only requirement is that MPI is pre-installed on the target system and available when running the AppImage executables.
MPI is not distributed within the AppImage package because of the system-dependent optimizations (e.g. specific InfiniBand settings).
Currently, PICLas executables are available as *[AppImage](https://appimage.org/)* for Linux.
Other operating systems, such as Windows or MacOS might be supported in the future.

Expand Down

0 comments on commit 7eddfbf

Please sign in to comment.