Skip to content

Cleanup the finding section#883

Open
fsimonis wants to merge 1 commit intomasterfrom
update-finding-section
Open

Cleanup the finding section#883
fsimonis wants to merge 1 commit intomasterfrom
update-finding-section

Conversation

@fsimonis
Copy link
Copy Markdown
Member

This PR cleans up the finding section.

  • I removed the warning about using from the build directory.
  • I changed the script to use conditional expansion, ${CPATH:+:$CPATH}, meaning if CPATH exists, evaluate to :$CPATH. Empty includes due to tailing : break compilers in super strange ways.
  • I added a statement on how to validate environment.d changes.
  • I added a section on how to verify the installation.

@fsimonis fsimonis requested a review from MakisH April 14, 2026 14:42
Copy link
Copy Markdown
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Useful cleanup, useful section addition. Thanks!

Only some nitpicking comments (some outside the changes of this PR).


```conf
# set this to your selected installation prefix
PRECICE_PREFIX="${HOME}/software/prefix"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing the quotes?

This method is discouraged as file layouts are fundamentally different, and we make **no** guarantees on keeping them consistent across releases.
Hence, the only reliable methods for using preCICE from the binary directory require `pkg-config` or `CMake`.
If your adapter or solver isn't using one of these methods, then we strongly suggest to install preCICE to a prefix or port the adapter to `pkg-config`.
If your adapter or solver isn't using one of these methods, we strongly suggest installing preCICE to a prefix or porting the adapter to `pkg-config` or `CMake`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If your adapter or solver isn't using one of these methods, we strongly suggest installing preCICE to a prefix or porting the adapter to `pkg-config` or `CMake`.
If your adapter or solver isn't using one of these methods, we strongly suggest installing preCICE to a prefix or porting the adapter to pkg-config or CMake.

At least for CMake, strange to have the name as a command. This is actually the same in the complete page.


```conf
# Only for using preCICE directly from the build directory
# (as of preCICE v3.3.0 - later versions might differ).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also bump the version here, since this PR is touching the page and the assumption still holds:

Suggested change
# (as of preCICE v3.3.0 - later versions might differ).
# (as of preCICE v3.4.0 - later versions might differ).

Comment on lines +100 to +106
After adding the file, logout and login again. Opening a new terminal will **not** be sufficient.
Verify the changes by listing the loaded environment in a new terminal:

```terminal
systemctl show-environment
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this intentional repetition?

Suggested change
After adding the file, logout and login again. Opening a new terminal will **not** be sufficient.
Verify the changes by listing the loaded environment in a new terminal:
```terminal
systemctl show-environment
```

If the library `libprecice.so` cannot be found, then `LD_LIBRARY_PATH` is incorrect.
If the displayed version differs from the version you expect, then you have multiple conflicting preCICE installations on your system.

Next run:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Next run:
Next, run:

@@ -32,12 +32,12 @@ 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"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shellcheck warning:

PRECICE_PREFIX="~/software/prefix"
                ^---------------^ SC2088 (warning): Tilde does not expand in quotes. Use $HOME.
Suggested change
PRECICE_PREFIX="~/software/prefix"
PRECICE_PREFIX="${HOME}/software/prefix"

@MakisH MakisH added the content Content-only issues label Apr 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants