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

Set P4est preferences before MPIPreferences #90

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Set P4est preferences before MPIPreferences #90

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69c3eeb
set P4est preferences before MPIPreferences
JoshuaLampert Oct 15, 2023
4d7eade
enable debug for testing CI
JoshuaLampert Oct 15, 2023
4a27c99
disable debug mode
JoshuaLampert Oct 16, 2023
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
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,7 @@ To enable this, you first need to obtain a local binary installation of
implementation used to build your local installation of
[`p4est`](https://github.com/cburstedde/p4est), see
[the documentation of MPI.jl](https://juliaparallel.org/MPI.jl/stable/configuration/).
At the time of writing, this can be done via

```julia
julia> using MPIPreferences

julia> MPIPreferences.use_system_binary()
```

if you use the default system MPI binary installation to build
[`p4est`](https://github.com/cburstedde/p4est).

Next, you need to set up the
At the time of writing, this can be done by first setting up the
[Preferences.jl](https://github.com/JuliaPackaging/Preferences.jl)
setting containing the path to your local build of the shared library of
[`p4est`](https://github.com/cburstedde/p4est).
Expand Down Expand Up @@ -126,6 +115,17 @@ To delete the preferences again, you can call `P4est.set_library_p4est!()` and
`P4est.set_library_sc!()`, respectively.

Note that you should restart your Julia session after changing the preferences.

Next, you need to set up the preferences for MPI, which can be done by
```julia
julia> using MPIPreferences

julia> MPIPreferences.use_system_binary()
```

if you use the default system MPI binary installation to build
[`p4est`](https://github.com/cburstedde/p4est).

To sum up, follow these steps to use
[P4est.jl](https://github.com/trixi-framework/P4est.jl) with a custom
installation of the underlying C libraries.
Expand All @@ -137,13 +137,7 @@ installation of the underlying C libraries.
new one if there is none.
- Install the required packages.
```julia
julia> Pkg.add(["MPIPreferences", "MPI", "UUIDs", "Preferences", "P4est"])
```
- Set [MPI.jl](https://github.com/JuliaParallel/MPI.jl) preferences.
```julia
julia> using MPIPreferences

julia> MPIPreferences.use_system_binary()
julia> Pkg.add(["MPIPreferences", "MPI", "P4est"])
```
- Set [P4est.jl](https://github.com/trixi-framework/P4est.jl) preferences.
```julia
Expand All @@ -155,6 +149,12 @@ installation of the underlying C libraries.
julia> P4est.set_library_sc!("/path/to/your/libsc.so")
[ Info: Please restart Julia and reload P4est.jl for the library changes to take effect
```
- Set [MPI.jl](https://github.com/JuliaParallel/MPI.jl) preferences.
```julia
julia> using MPIPreferences

julia> MPIPreferences.use_system_binary()
```
- Restart the Julia REPL and load the packages.
```julia
julia> import Pkg; Pkg.activate(".")
Expand Down
Loading