Skip to content

Add environment config example for local build #672

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

Open
MakisH wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add environment config example for local build #672

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 24 additions & 12 deletions content/docs/installation/building-from-source/installation-source-finding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Then add the following to your `.profile` (for bash) or `.zshrc` (for zsh).

```bash
# set this to your selected installation prefix
PRECICE_PREFIX=~/software/prefix
export PATH=$PRECICE_PREFIX/bin:$PATH
export LD_LIBRARY_PATH=$PRECICE_PREFIX/lib:$LD_LIBRARY_PATH
export CPATH=$PRECICE_PREFIX/include:$CPATH
PRECICE_PREFIX="~/software/prefix"
export PATH="${PRECICE_PREFIX}/bin:${PATH}"
export LD_LIBRARY_PATH="${PRECICE_PREFIX}/lib:${LD_LIBRARY_PATH}"
export CPATH="${PRECICE_PREFIX}/include:${CPATH}"
# Enable detection with pkg-config and CMake
export PKG_CONFIG_PATH=$PRECICE_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH
export CMAKE_PREFIX_PATH=$PRECICE_PREFIX:$CMAKE_PREFIX_PATH
export PKG_CONFIG_PATH="${PRECICE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}"
export CMAKE_PREFIX_PATH="${PRECICE_PREFIX}:${CMAKE_PREFIX_PATH}"
```

After adding these variables, start a new session (open a new terminal or logout and login again).
Expand All @@ -57,13 +57,13 @@ Then create a file `~/.config/environment.d/99-precice.conf` with the content:

```conf
# set this to your selected installation prefix
PRECICE_PREFIX=$HOME/software/prefix
PATH=${PRECICE_PREFIX}/bin:${PATH}
LD_LIBRARY_PATH=${PRECICE_PREFIX}/lib:${LD_LIBRARY_PATH}
CPATH=${PRECICE_PREFIX}/include:${CPATH}
PRECICE_PREFIX="${HOME}/software/prefix"
PATH="${PRECICE_PREFIX}/bin:${PATH}"
LD_LIBRARY_PATH="${PRECICE_PREFIX}/lib:${LD_LIBRARY_PATH}"
CPATH="${PRECICE_PREFIX}/include:${CPATH}"
# Enable detection with pkg-config and CMake
PKG_CONFIG_PATH=${PRECICE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
CMAKE_PREFIX_PATH=${PRECICE_PREFIX}:${CMAKE_PREFIX_PATH}
PKG_CONFIG_PATH="${PRECICE_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}"
CMAKE_PREFIX_PATH="${PRECICE_PREFIX}:${CMAKE_PREFIX_PATH}"
```

After adding the file, logout and login again. Opening a new terminal will not be sufficient.
Expand All @@ -86,6 +86,18 @@ First extend `LD_LIBRARY_PATH` with the binary directory if you don't plan to us
For `pkg-config` users, extend `PKG_CONFIG_PATH` with the binary directory.
For `CMake` users, either set the environment variable `precice_DIR` to the binary directory prior to calling `CMake`, or pass it as a `CMake` variable during configuration.

```conf
# Only for using preCICE directly from the build directory
# (as of preCICE v3.3.0 - later versions might differ).
# Prefer installing to a prefix (see above).

PRECICE_BUILD="/path/to/precice/build"
PATH="${PRECICE_BUILD}:${PATH}"
LD_LIBRARY_PATH="${PRECICE_BUILD}:${LD_LIBRARY_PATH}"
PKG_CONFIG_PATH="${PRECICE_BUILD}:${PKG_CONFIG_PATH}"
CMAKE_PREFIX_PATH="${PRECICE_BUILD}:${CMAKE_PREFIX_PATH}"
```

## Next steps

This concludes the preCICE installation for custom prefixes and you should have a working installation of preCICE on your system.
Expand Down