doc/languages-frameworks/julia.section.md

   1 # Julia {#language-julia}
   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 {
  30   precompile = false; # Turn off precompilation
  31 }) ["Plots"]
  32 ```
  33
  34 Here's a nice way to run a Julia environment with a shell one-liner:
  35
  36 ```sh
  37 nix-shell -p 'julia.withPackages ["Plots"]' --run julia
  38 ```
  39
  40 ### Arguments {#julia-withpackage-arguments}
  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
  52   Should not be needed as we try to obtain library dependencies automatically using Julia's artifacts system.
  53
  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
  64   For example, you can use a custom version of the `LanguageServer` package by passing `packageOverrides = { "LanguageServer" = fetchFromGitHub {...}; }`.
  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.