xref: /libCEED/julia/LibCEED.jl/docs/src/LibCEED.md (revision 6c6044755ff91cefef5da44fde896bd53fec652f)
1*acf255f5SWill Pazner# Library configuration
2*acf255f5SWill Pazner
3*acf255f5SWill PaznerBy default, LibCEED.jl uses a "basic version" of the libCEED library that is
4*acf255f5SWill Paznerbundled as a pre-built binary. In order to access more advanced features (CUDA
5*acf255f5SWill Paznersupport, architecture-specific compiler flags, etc.), users can use LibCEED.jl
6*acf255f5SWill Paznerwith a other versions of the libCEED library (e.g. compiled from source).
7*acf255f5SWill Pazner
8*acf255f5SWill PaznerThis is achieved by by calling [`set_libceed_path!`](@ref) with the path to the
9*acf255f5SWill Paznerlibrary file. The choice of library file is stored as a per-environment
10*acf255f5SWill Paznerpreference. For changes to take effect, the Julia session must be restarted. The
11*acf255f5SWill Paznerlibrary currently being used by LibCEED.jl can be queried using
12*acf255f5SWill Pazner[`get_libceed_path`](@ref).
13*acf255f5SWill Pazner
14*acf255f5SWill PaznerThe version number of the currently loaded libCEED library can also be queried
15*acf255f5SWill Paznerusing [`ceedversion`](@ref).
16*acf255f5SWill Pazner
17*acf255f5SWill Pazner```@docs
18*acf255f5SWill Paznerceedversion
19*acf255f5SWill Paznerisrelease
20*acf255f5SWill Paznerset_libceed_path!
21*acf255f5SWill Pazneruse_prebuilt_libceed!
22*acf255f5SWill Paznerget_libceed_path
23*acf255f5SWill Pazner```
24