···

       
2
       
 
       


     

       
3
       
 
       
## Introduction {#julia-introduction}

     

       
4
       
 
       


     

       
5
       
-
       
Nixpkgs includes Julia as the `julia` derivation. You can get specific versions by looking at the other `julia*` top-level derivations available. For example, `julia_19` corresponds to Julia 1.9. We also provide the current stable version as `julia-stable`, and an LTS version as `julia-lts`.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
6
       
 
       


     

       
7
       
-
       
Occasionally, a Julia version has been too difficult to build from source in Nixpkgs and has been fetched prebuilt instead. These Julia versions are differentiated with the `*-bin` suffix; for example, `julia-stable-bin`.

     

       
0
       
 
       

     

       
8
       
 
       


     

       
9
       
 
       
## julia.withPackages {#julia-withpackage}

     

       
10
       
 
       


     

       
11
       
 
       
The basic Julia derivations only provide the built-in packages that come with the distribution.

     

       
12
       
 
       


     

       
13
       
-
       
You can build Julia environments with additional packages using the `julia.withPackages` command. This function accepts a list of strings representing Julia package names. For example, you can build a Julia environment with the `Plots` package as follows.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
14
       
 
       


     

       
15
       
 
       
```nix

     

       
16
       
 
       
julia.withPackages ["Plots"]

     

       
17
       
 
       
```

     

       
18
       
 
       


     

       
19
       
-
       
Arguments can be passed using `.override`. For example:

     

       
0
       
 
       

     

       
20
       
 
       


     

       
21
       
 
       
```nix

     

       
22
       
 
       
(julia.withPackages.override {

     
···

       
34
       
 
       


     

       
35
       
 
       
* `precompile`: Whether to run `Pkg.precompile()` on the generated environment.

     

       
36
       
 
       


     

       
37
       
-
       
  This will make package imports faster, but may fail in some cases. For example, there is an upstream issue with `Gtk.jl` that prevents precompilation from working in the Nix build sandbox, because the precompiled code tries to access a display. Packages like this will work fine if you build with `precompile=false`, and then precompile as needed once your environment starts. Defaults to `true`.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
38
       
 
       


     

       
39
       
 
       
* `extraLibs`: Extra library dependencies that will be placed on the `LD_LIBRARY_PATH` for Julia.

     

       
40
       
 
       


     
···

       
43
       
 
       
* `makeWrapperArgs`: Extra arguments to pass to the `makeWrapper` call which we use to wrap the Julia binary.

     

       
44
       
 
       
* `setDefaultDepot`: Whether to automatically prepend `$HOME/.julia` to the `JULIA_DEPOT_PATH`.

     

       
45
       
 
       


     

       
46
       
-
       
  This is useful because Julia expects a writable depot path as the first entry, which the one we build in Nixpkgs is not. If there's no writable depot, then Julia will show a warning and be unable to save command history logs etc. Defaults to `true`.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
47
       
 
       


     

       
48
       
 
       
* `packageOverrides`: Allows you to override packages by name by passing an alternative source.

     

       
49
       
 
       


     
···

       
51
       
 
       


     

       
52
       
 
       
* `augmentedRegistry`: Allows you to change the registry from which Julia packages are drawn.

     

       
53
       
 
       


     

       
54
       
-
       
  This normally points at a special augmented version of the Julia [General packages registry](https://github.com/JuliaRegistries/General). If you want to use a bleeding-edge version to pick up the latest package updates, you can plug in a later revision than the one in Nixpkgs.

     

       
0
       
 
       

     

···

       
2
       
 
       


     

       
3
       
 
       
## Introduction {#julia-introduction}

     

       
4
       
 
       


     

       
5
       
+
       
Nixpkgs includes Julia as the `julia` derivation.

     

       
6
       
+
       
You can get specific versions by looking at the other `julia*` top-level derivations available.

     

       
7
       
+
       
For example, `julia_19` corresponds to Julia 1.9.

     

       
8
       
+
       
We also provide the current stable version as `julia-stable`, and an LTS version as `julia-lts`.

     

       
9
       
 
       


     

       
10
       
+
       
Occasionally, a Julia version has been too difficult to build from source in Nixpkgs and has been fetched prebuilt instead.

     

       
11
       
+
       
These Julia versions are differentiated with the `*-bin` suffix; for example, `julia-stable-bin`.

     

       
12
       
 
       


     

       
13
       
 
       
## julia.withPackages {#julia-withpackage}

     

       
14
       
 
       


     

       
15
       
 
       
The basic Julia derivations only provide the built-in packages that come with the distribution.

     

       
16
       
 
       


     

       
17
       
+
       
You can build Julia environments with additional packages using the `julia.withPackages` command.

     

       
18
       
+
       
This function accepts a list of strings representing Julia package names.

     

       
19
       
+
       
For example, you can build a Julia environment with the `Plots` package as follows.

     

       
20
       
 
       


     

       
21
       
 
       
```nix

     

       
22
       
 
       
julia.withPackages ["Plots"]

     

       
23
       
 
       
```

     

       
24
       
 
       


     

       
25
       
+
       
Arguments can be passed using `.override`.

     

       
26
       
+
       
For example:

     

       
27
       
 
       


     

       
28
       
 
       
```nix

     

       
29
       
 
       
(julia.withPackages.override {

     
···

       
41
       
 
       


     

       
42
       
 
       
* `precompile`: Whether to run `Pkg.precompile()` on the generated environment.

     

       
43
       
 
       


     

       
44
       
+
       
  This will make package imports faster, but may fail in some cases.

     

       
45
       
+
       
  For example, there is an upstream issue with `Gtk.jl` that prevents precompilation from working in the Nix build sandbox, because the precompiled code tries to access a display.

     

       
46
       
+
       
  Packages like this will work fine if you build with `precompile=false`, and then precompile as needed once your environment starts.

     

       
47
       
+
       


     

       
48
       
+
       
  Defaults: `true`

     

       
49
       
 
       


     

       
50
       
 
       
* `extraLibs`: Extra library dependencies that will be placed on the `LD_LIBRARY_PATH` for Julia.

     

       
51
       
 
       


     
···

       
54
       
 
       
* `makeWrapperArgs`: Extra arguments to pass to the `makeWrapper` call which we use to wrap the Julia binary.

     

       
55
       
 
       
* `setDefaultDepot`: Whether to automatically prepend `$HOME/.julia` to the `JULIA_DEPOT_PATH`.

     

       
56
       
 
       


     

       
57
       
+
       
  This is useful because Julia expects a writable depot path as the first entry, which the one we build in Nixpkgs is not.

     

       
58
       
+
       
  If there's no writable depot, then Julia will show a warning and be unable to save command history logs etc.

     

       
59
       
+
       


     

       
60
       
+
       
  Default: `true`

     

       
61
       
 
       


     

       
62
       
 
       
* `packageOverrides`: Allows you to override packages by name by passing an alternative source.

     

       
63
       
 
       


     
···

       
65
       
 
       


     

       
66
       
 
       
* `augmentedRegistry`: Allows you to change the registry from which Julia packages are drawn.

     

       
67
       
 
       


     

       
68
       
+
       
  This normally points at a special augmented version of the Julia [General packages registry](https://github.com/JuliaRegistries/General).

     

       
69
       
+
       
  If you want to use a bleeding-edge version to pick up the latest package updates, you can plug in a later revision than the one in Nixpkgs.