jlm: System image manager for Julia¶
Installation¶
(v1.1) pkg> add JuliaManager
...
julia> using JuliaManager
julia> JuliaManager.install_cli()
...
You need to add ~/.julia/bin to $PATH as would be messaged if it not.
Examples¶
Standard usage¶
$ cd PATH/TO/YOUR/PROJECT
$ jlm init
...
$ jlm run
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.1.0 (2019-01-21)
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release
|__/ |
julia>
Using MKL.jl-patched Julia and standard Julia side-by-side¶
MKL.jl is a convenient way of using Intel’s Math Kernel Library
(MKL) with Julia. However, it still has some caveats and difficult to
use standard Julia installation since precompilation cache are shared.
This problem can be avoided by using jlm to separate compilation
cache paths for MKL.jl and non-MKL.jl Julia. This way, both Julia
installations can be used simultaneously without invoking repeated
precompilation.
As MKL.jl overwrites its Julia installation, you need to create a dedicated Julia installation. Suppose it’s done by
$ mkdir -p ~/opt/julia-mkl
$ cd ~/opt/julia-mkl
$ cd tar xf ~/Downloads/julia-1.1.0-linux-x86_64.tar.gz
Then create a project and install MKL.jl in it. Note that it is
better be done in a separate project to avoid installing MKL.jl where
standard (non-MKL.jl) Julia may accidentally instantiate and build it.
This isolation is done by --project=.:
$ cd PATH/TO/PROJECT
$ ~/opt/julia-mkl/julia-1.1.0/bin/julia \
--startup-file=no --compiled-modules=no --project=.
...
(PROJECT) pkg> add https://github.com/JuliaComputing/MKL.jl
You may also need to run pkg> build MKL.
Finally, use jlm to isolate precompilation cache:
$ jlm init ~/opt/julia-mkl/julia-1.1.0/bin/julia
...
$ jlm run --project=.
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.1.0 (2019-01-21)
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release
|__/ |
(This may cause (re)compilation of cache files if you import some
packages in ~/.julia/config/startup.jl.)
In Julia REPL, you can check if jlm is using the correct version of Julia by
julia> Base.julia_cmd().exec[1]
"/home/USER/opt/julia-mkl/julia-1.1.0/bin/julia"
julia> using LinearAlgebra
julia> BLAS.vendor()
:mkl
Manual¶
Command line interface to manage Julia’s system images.
usage: jlm [-h] [--version] [--dry-run] [--verbose] [--pdb] [--jlm-dir PATH]
{run,init,set-default,set-sysimage,unset-sysimage,create-default-sysimage,install-backend,update-backend,info,locate}
...
Named Arguments¶
- --version
show program’s version number and exit
- --dry-run
Default: False
- --verbose, -v
Default: False
- --pdb
Default: False
- --jlm-dir
Specify the
.jlmdirectory which is created byjlm initand stores information forjlm. By default,.jlmdirectory found in the nearest “ancestor” directory is used. Runjlm locate dirto locate the actual directory that would be used.
Sub-commands:¶
run¶
Run julia executable with appropriate system image.
jlm run [-h] [julia] [arguments [arguments ...]]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.- arguments
Arguments and options passed to
julia. Non-option like argument (i.e., the ones not starting with-) followingrunis always interpreted as a Julia executable. To pass a file path to Julia, use--as the first argument torun; i.e.jlm ... run -- PATH/TO/FILE.jl .... If you passjuliatorun, there is no need to pass--since the argument parsing forjlmautomatically ends at this point.
If argument julia is not given, the default executable configured by
jlm init is used.
init¶
Initialize jlm.
jlm init [-h] [--sysimage SYSIMAGE] [julia]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
Named Arguments¶
- --sysimage, -J
The path to system image.
jlm init does:
Create a data store (
.jlmdirectory).Install
JuliaManager.jlif it is not installed for<julia>.Compile the “patched” default system image (see note below) for
<julia>if not already found and--sysimage|-Jis not given. This can be done separately byjlm compile-default-sysimage.Set the system image to be used for
<julia>. This can be re-done later byset-sysimage.
Note
jlm compiles the system image with a patch that does Suggestion:
Use different precompilation cache path for different system image
by tkf · Pull Request #29914 · JuliaLang/julia
set-default¶
Set default Julia executable to be used.
jlm set-default [-h] julia
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
set-sysimage¶
Set system image for juila.
jlm set-sysimage [-h] [julia] sysimage
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.- sysimage
The path to system image.
unset-sysimage¶
Unset system image for juila.
jlm unset-sysimage [-h] [julia]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
create-default-sysimage¶
Compile default system image for julia.
jlm create-default-sysimage [-h] [--force] [julia]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
Named Arguments¶
- --force, -f
Re-compile default system image for
juliaeven if it already exists.Default: False
install-backend¶
Install JuliaManager.jl for this julia.
jlm install-backend [-h] [julia]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
update-backend¶
Update JuliaManager.jl for this julia.
jlm update-backend [-h] [julia]
Positional Arguments¶
- julia
The name of Julia executable on
$PATHor a path to the Julia executable.
locate¶
Show paths to related files and directories
jlm locate [-h] {sysimage,base,dir,home-dir} ...
