sysimg/: ReadMe, build script

Author: tfiers

sysimg/ReadMe.md

@@ -0,0 +1,27 @@
+These scripts can be used to generate a custom "system image" with PackageCompiler.jl, like [here](
+https://julialang.github.io/PackageCompiler.jl/stable/examples/plots.html).
+
+The goal is to have to wait less long for package imports and first function calls in a
+fresh Julia session.
+
+
+### Build
+To build the image, run, in the repo root:
+```
+julia sysimg/build.jl
+```
+This takes a few minutes.
+
+
+### Use
+
+To use the generated system image:
+- On the command line:
+  ```
+  julia --sysimg=sysimg/mysis.dll
+  ```
+- As a 'kernel' in Jupyter: [relevant IJulia docs](
+    https://julialang.github.io/IJulia.jl/stable/manual/installation/#Installing-additional-Julia-kernels)
+    - Make sure to also add the flag `"--project=@."`.
+    - For me, the generated kernel definition file is located at:
+      `C:\Users\tfiers\AppData\Roaming\jupyter\kernels\julia-preloaded-1.7\kernel.json`

sysimg/build.jl

@@ -0,0 +1,15 @@
+using PackageCompiler
+
+create_sysimage(
+    [
+        :Revise,
+        :PyCall,
+        :IJulia,
+        :PyPlot,
+        :DataFrames,
+        :ComponentArrays,
+    ];
+    sysimage_path               = "sysimg/mysys.dll",
+    precompile_execution_file   = "sysimg/to_precompile.jl",
+    script                      = "sysimg/pyplot_delay_init.jl",
+)

sysimg/to_precompile.jl

@@ -1,26 +1,3 @@
-# For use with PackageCompiler.jl, to generate a custom "system image", like here:
-# https://julialang.github.io/PackageCompiler.jl/stable/examples/plots.html.
-#
-# The goal is having to wait less long for package imports and first function calls in a
-# fresh Julia session.
-#
-# Commands to run, in the repo root:
-#=
-using PackageCompiler
-pkgs = [:Revise, :PyCall, :IJulia, :PyPlot, :DataFrames, :ComponentArrays]
-sysimage_path             = "sysimg/mysys.dll"
-precompile_execution_file = "sysimg/to_precompile.jl"
-script                    = "sysimg/pyplot_delay_init.jl"
-create_sysimage(pkgs; sysimage_path, precompile_execution_file, script)
-=#
-# To use this system image:
-# - On the command line: `julia --sysimg=sysimg/mysis.dll`
-# - As a 'kernel' in Jupyter:
-#     https://julialang.github.io/IJulia.jl/stable/manual/installation/#Installing-additional-Julia-kernels
-#   Make sure to also add the flag "--project=@.".
-#   For me, the generated kernel definition file is located at:
-#     C:\Users\tfiers\AppData\Roaming\jupyter\kernels\julia-preloaded-1.7\kernel.json
-
 using PyPlot, DataFrames, ComponentArrays
 
 df = DataFrame([(a=1, b=2), (a=2, b=2)])