Skip to content
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

Update system guides #179

Merged
merged 15 commits into from
Aug 13, 2022
Merged

Update system guides #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
403ecae
Remove Ubuntu 16.04, add warning for 18.04
MakisH Jul 4, 2022
ff0e636
System guides: Add hint for Ubuntu 22.04
MakisH Jul 4, 2022
00f9be6
Update Ubuntu version in CalculiX adapter, add hint
MakisH Jul 4, 2022
3edfdf4
Installation-packages: Bump Ubuntu version
MakisH Jul 4, 2022
2c9cd21
Update installation instructions on OpenSUSE
boris-martin Jul 5, 2022
16168be
Update installation-source-dependencies.md
boris-martin Jul 5, 2022
098b8de
Update Fedora dependencies guide
MakisH Jul 5, 2022
1cf8977
Fedora: document hdf5-openmpi-devel
MakisH Aug 9, 2022
21fa86c
Swap Ubuntu 22.04 and 20.04
MakisH Aug 9, 2022
9b22abf
Update macOS instructions
MakisH Aug 9, 2022
236e254
Update CentOS guides
MakisH Aug 9, 2022
27366d2
Merge branch 'master' into update-system-guides
MakisH Aug 9, 2022
6075dc8
Add Rocky Linux 9
MakisH Aug 10, 2022
7fbbca3
Merge branch 'update-system-guides' of github.com:precice/precice.git…
MakisH Aug 10, 2022
cd3351e
Fix Markdown
MakisH Aug 10, 2022
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
10 changes: 7 additions & 3 deletions pages/docs/adapters/calculix/adapter-calculix-get-adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,19 @@ There are two ways to get the adapter: (a) get a binary package (Ubuntu-only), o

You can download version-specific Ubuntu (Debian) packages from each [adapter release](https://github.com/precice/calculix-adapter/releases/latest). To install, simply open it in your software center.

Alternatively, download & install it from the command line. For Ubuntu 20.04 (focal):
Alternatively, download & install it from the command line. For Ubuntu 22.04 (jammy):

```bash
wget https://github.com/precice/calculix-adapter/releases/download/v{{ site.calculix_adapter_version }}/calculix-precice2_{{ site.calculix_adapter_version }}-1_amd64_focal.deb
sudo apt install ./calculix-precice2_{{ site.calculix_adapter_version }}-1_amd64_focal.deb
wget https://github.com/precice/calculix-adapter/releases/download/v{{ site.calculix_adapter_version }}/calculix-precice2_{{ site.calculix_adapter_version }}-1_amd64_jammy.deb
sudo apt install ./calculix-precice2_{{ site.calculix_adapter_version }}-1_amd64_jammy.deb
```
MakisH marked this conversation as resolved.
Show resolved Hide resolved

This requires that also preCICE itself has been installed from a Debian package.

{% tip %}
Replace `jammy` with `focal` to get the package for Ubuntu 20.04.
{% endtip %}

{% note %}
We started offering Debian packages for the CalculiX adapter since v2.19.0. Please [give us your feedback](community-channels.html)!
{% endnote %}
Expand Down
10 changes: 5 additions & 5 deletions pages/docs/installation/installation-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ This section lists systems and instructions on how to install these packages.
You can download version-specific Ubuntu (Debian) packages from each [GitHub release](https://github.com/precice/precice/releases/latest).
To install, simply open it in your software center.

Alternatively, download & install it from the command line. For **Ubuntu 20.04 (focal)**:
Alternatively, download & install it from the command line. For **Ubuntu 22.04 (jammy)**:

```bash
wget https://github.com/precice/precice/releases/download/v{{ site.precice_version }}/libprecice2_{{ site.precice_version }}_focal.deb
sudo apt install ./libprecice2_{{ site.precice_version }}_focal.deb
wget https://github.com/precice/precice/releases/download/v{{ site.precice_version }}/libprecice2_{{ site.precice_version }}_jammy.deb
sudo apt install ./libprecice2_{{ site.precice_version }}_jammy.deb
```
MakisH marked this conversation as resolved.
Show resolved Hide resolved

We support the latest two Ubuntu LTS versions, as well as the latest normal Ubuntu release.
Check the [official release-cyle](https://ubuntu.com/about/release-cycle) for more information and the version code names.
As an example, change `focal` to `hirsute` for 21.04, `groovy` for 20.10, or to `bionic` for 18.04.
As an example, change `jammy` to `focal` for 20.04.

Is a newer preCICE release out and we have not yet updated the above links? Please [edit this page](https://github.com/precice/precice.github.io_future/blob/master/pages/docs/installation/installation-packages.md).
Is a newer preCICE release out and we have not yet updated the above links? Please edit this page.

## Arch Linux / Manjaro

Expand Down
98 changes: 63 additions & 35 deletions pages/docs/installation/installation-source-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,9 @@ If you want build preCICE on your own computer and you are using one of the foll

Other modern versions of popular Linux distributions are also perfectly compatible, here we just list a few popular options. Since our users have tried preCICE on various distributions, you may as well ask on our [forum](https://precice.discourse.group/) for any questions.

### Ubuntu 20.04 LTS Focal Fossa
### Ubuntu 22.04 LTS Jammy Jellyfish

With every release, we also ship [binary packages for Ubuntu 20.04](https://github.com/precice/precice/releases). However, if you still want to build from source, everything is available through the distribution's repositories:
With every release, we also ship [binary packages for Ubuntu 22.04](https://github.com/precice/precice/releases). However, if you still want to build from source, everything is available through the distribution's repositories:

```bash
sudo apt update && \
Expand All @@ -273,8 +273,16 @@ sudo apt install build-essential cmake libeigen3-dev libxml2-dev libboost-all-de

The same instructions apply for later Ubuntu releases.

### Ubuntu 20.04 LTS Focal Fossa

Follow the same instructions as for Ubuntu 22.04.

### Ubuntu 18.04 Bionic Beaver

{% warning %}
The last release of preCICE to support Ubuntu 18.04 was [preCICE v2.3.0](https://github.com/precice/precice/releases/tag/v2.3.0).
{% endwarning %}

With every release, we also ship [binary packages for Ubuntu 18.04](https://github.com/precice/precice/releases).
However, if you still want to build from source, almost everything is available through the distribution's repositories:

Expand All @@ -286,26 +294,6 @@ sudo apt install build-essential cmake libeigen3-dev libxml2-dev libboost-all-de
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`.
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.

### Ubuntu 16.04 Xenial Xerus

In Ubuntu 16.04, only a fraction of packages is available through the distribution's repositories.
Further packages needs to be build from source.
First install the available packages:

```bash
sudo apt update && \
sudo apt install build-essential g++-5 libxml2-dev python3-dev python3-numpy
```

Next, you need to install [CMake](#cmake), [Eigen](#eigen) and [boost](#boost) as described in their respective sections.

If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and [build with `-DPRECICE_PETScMapping=OFF`](Building:-Using-CMake#options).
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.

{% note %}
The repositories contain a package `libeigen3-dev`, however, using it results in [issues with nearest-projection mapping](https://github.com/precice/precice/issues/603#issuecomment-573139840).
{% endnote %}

### Debian 11 Bullseye

Everything is available from the distribution's repositories:
Expand All @@ -329,29 +317,63 @@ apt install build-essential cmake libeigen3-dev libxml2-dev libboost-all-dev pyt
If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`.
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.

### Fedora 34
### Fedora 36

In Fedora 33 and 34, everything is available through the distribution's repositories:
In Fedora, everything is available through the distribution's repositories:

```bash
sudo dnf update
sudo dnf install gcc-c++ cmake libxml2-devel boost-devel openmpi-devel petsc-openmpi-devel eigen3-devel python3-devel
sudo dnf install gcc-c++ cmake libxml2-devel boost-devel openmpi-devel petsc-openmpi-devel hdf5-openmpi-devel eigen3-devel python3-devel
```

Note that `hdf5-openmpi-devel` is only needed to detect the PETSc installation ([details](https://github.com/precice/precice.github.io/pull/179#issuecomment-1207865435)).

Afterwards, start a new terminal, to make MPI discoverable (read more about [MPI on Fedora](https://docs.fedoraproject.org/en-US/neurofedora/mpi/)). Before configuring & building preCICE, load MPI using the module:

```bash
module load mpi/openmpi-x86_64
```

(if `module` is not available, you may need to log out and in again)

{% note %}
In case you use the docker image of fedora, you need to install the support for environment modules first: `sudo dnf install environment-modules`
{% endnote %}

If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`. You may need this with older preCICE and Fedora versions (e.g. preCICE v2.1 on Fedora 32 or earlier, see a [related issue](https://github.com/precice/precice/issues/864).

### Rocky Linux 9

Rocky Linux very closely follows the conventions previously set by CentOS. We first need to install common development tools, enable the [CRB repository](https://wiki.rockylinux.org/rocky/repo/) (only for Eigen), install the dependencies, load the MPI module, and continue with building preCICE.

1. First, install the [Development Tools](https://serverfault.com/questions/814671/centos-how-do-i-check-if-development-tools-is-installed) group (compilers, Git, make, pkg-config, ...):

```bash
sudo dnf update
sudo dnf install dnf-plugins-core
sudo dnf groupinstall "Development Tools"
```

2. Then, install the available preCICE dependencies:

```bash
sudo dnf install cmake libxml2-devel boost-devel openmpi-devel eigen3-devel python3-devel
```

3. Before configuring & building preCICE, load MPI (you may need to log out and in again, if `module` is not found):

```bash
module load mpi/openmpi-x86_64
```

4. Unfortunately, [PETSc does not seem to be available in this distribution.](https://pkgs.org/search/?q=petsc), so we need to switch that off later when building preCICE. If you don't plan to use RBF mappings in large parallel cases, you can continue without installing PETSc and build preCICE with `-DPRECICE_PETScMapping=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.

### CentOS 8

{% warning %}
The last release of preCICE to support CentOS 8 was [preCICE v2.3.0](https://github.com/precice/precice/releases/tag/v2.3.0).
{% endwarning %}

(The same instructions apply also to Rocky Linux 8)

This system requires to install some tools in a fixed order.
Expand All @@ -376,17 +398,20 @@ This system requires to install some tools in a fixed order.
pip3 install --user numpy
```

3. Before configuring & building preCICE, load MPI:
3. Before configuring & building preCICE, load MPI (you may need to log out and in again, if `module` is not found):

```bash
module load mpi/openmpi-x86_64
```

4. Unfortunately, the PETSc package (`petsc-openmpi-devel`) in this distribution is too old. If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc and build with `-DPRECICE_PETScMapping=OFF`.
If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.
4. Unfortunately, the PETSc package (`petsc-openmpi-devel`) in this distribution is too old. If you don't plan to use RBF mappings in large parallel cases you can continue without installing PETSc, and build preCICE with `-DPRECICE_PETScMapping=OFF`. If you need PETSc, follow the steps in the [PETSc](#petsc) section and you are done.

### CentOS 7

{% warning %}
The last release of preCICE to support CentOS 7 was [preCICE v2.3.0](https://github.com/precice/precice/releases/tag/v2.3.0).
{% endwarning %}

This system requires to install some tools in a fixed order.

1. First install the group 'Development Tools'.
Expand Down Expand Up @@ -428,17 +453,18 @@ This system requires to install some tools in a fixed order.
Use `cmake3` instead of `cmake` to configure preCICE!
{% endimportant %}

### OpenSUSE Leap 15.2
### OpenSUSE Leap 15.4

In OpenSUSE Leap 15.2, things are a bit more complicated (please contribute in this section). Get the basic dependencies:
In OpenSUSE Leap 15.4, things are a bit more complicated (please contribute in this section). Get the basic dependencies:

```bash
sudo zypper refresh
sudo zypper install gcc-c++ make cmake libxml2-devel \
libboost_log1_66_0-devel libboost_thread1_66_0-devel libboost_system1_66_0-devel libboost_filesystem1_66_0-devel libboost_program_options1_66_0-devel libboost_test1_66_0-devel \
libboost_log1_75_0-devel libboost_thread1_75_0-devel libboost_system1_75_0-devel libboost_filesystem1_75_0-devel libboost_program_options1_75_0-devel libboost_test1_75_0-devel \
eigen3-devel python3-devel
```

Furthermore, Numpy is needed. It can be installed through pip: `pip3 install --user numpy`.
You may need to set the Eigen location when configuring preCICE:

```bash
Expand All @@ -457,17 +483,19 @@ cmake -DPRECICE_MPICommunication=OFF -DPRECICE_PETScMapping=OFF <options as usua

Good news: [preCICE is already on AUR](https://aur.archlinux.org/packages/precice/), so you can directly use or modify the respective `PKGBUILD`.

### macOS Catalina 10.15
### macOS

These instructions were written for macOS Catalina (10). We are aware of users using preCICE in newer macOS versions, including macOS Big Sur (11), while our [automated tests](https://github.com/precice/precice/actions/workflows/build-and-test-mac.yml) run on the [GitHub Actions macos-latest runner](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). Contributions to this section would be particularly helpful.

First, `XCode Command Line Tools` should be installed from [Apple Developer page](https://developer.apple.com/download/more/) or from XCode application.
First, install `XCode Command Line Tools` from the [Apple Developer page](https://developer.apple.com/download/more/) or from XCode.

Then, all the dependencies can be installed using a package manager such as [Homebrew](https://brew.sh/) or [MacPorts](https://www.macports.org/):
You can then install all dependencies using [Homebrew](https://brew.sh/):

```bash
brew install cmake eigen libxml2 boost petsc openmpi python3 numpy
```

or
or, alternatively, using [MacPorts](https://www.macports.org/)

```bash
port install cmake eigen3 libxml2 boost petsc openmpi python3 numpy
Expand Down