Skip to content

Commit 21cd6c1

Browse files
committed
Update the README.md of GALAHAD.jl
1 parent f5d1e80 commit 21cd6c1

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

GALAHAD.jl/README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,33 @@ libraries.
3636

3737
To use your own installation of `GALAHAD`, set the environment variable
3838
`JULIA_GALAHAD_LIBRARY_PATH` to point to the folder that contains the
39-
shared libraries `libgalahad_single` and `libgalahad_double` before
40-
`using GALAHAD`.
39+
shared libraries `libgalahad_single`, `libgalahad_double` and `libgalahad_quadruple`
40+
before `using GALAHAD`.
4141

4242
```bash
4343
export JULIA_GALAHAD_LIBRARY_PATH=/home/alexis/Applications/GALAHAD/lib
4444
```
4545

46-
The `JULIA_GALAHAD_LIBRARY_PATH` environment variable may be set
47-
permanently in the shell's startup file, or in
48-
`$HOME/.julia/config/startup.jl`
49-
via
50-
`ENV["JULIA_GALAHAD_LIBRARY_PATH"] = "/home/alexis/Applications/GALAHAD/lib".
46+
The environment variable `JULIA_GALAHAD_LIBRARY_PATH` can be set
47+
permanently in your shell's startup file (e.g., `.bashrc`)
48+
or in Julia's startup file at `$HOME/.julia/config/startup.jl`.
5149

50+
You can also define it directly from within Julia:
51+
```julia
52+
ENV["JULIA_GALAHAD_LIBRARY_PATH"] = "/home/alexis/Applications/GALAHAD/lib"
53+
```
54+
55+
You can check whether you're using the default precompiled libraries (`"YGGDRASIL"`)
56+
or your own local ones (`"CUSTOM"`) by inspecting the constant `GALAHAD_INSTALLATION` in `GALAHAD.jl`:
57+
```julia
58+
using GALAHAD
59+
GALAHAD.GALAHAD_INSTALLATION
60+
```
61+
62+
If you have set the environment variable `JULIA_GALAHAD_LIBRARY_PATH` but `GALAHAD_INSTALLATION` still shows `"YGGDRASIL"`,
63+
you may need to regenerate the cache of `GALAHAD.jl` by running:
64+
65+
```julia
66+
force_recompile(package_name::String) = Base.compilecache(Base.identify_package(package_name))
67+
force_recompile("GALAHAD")
68+
```

0 commit comments

Comments
 (0)