Script to build sys image for AlgebraicJulia service (#289)

* wip need to make sure jupyter server starts with sysimage

* 9s startup versus 21s startup. adding helper script

* added test precompilation statements

* removed kernel checking conditional

* Delete packages/sysimages/Manifest.toml

* CLEANUP: Move sys image scripts to main Julia dir.

Also, frontend now uses the default kernel set in the Jupyter server.

---------

Co-authored-by: Evan Patterson <evan@epatters.org>

Author: quffaro

packages/algjulia-service/.gitignore

@@ -22,3 +22,6 @@ docs/site/
 # committed for packages, but should be committed for applications that require a static
 # environment.
 Manifest.toml
+
+# Julia sys images
+*.so

packages/algjulia-service/Project.toml

@@ -29,6 +29,7 @@ Decapodes = "0.5.6"
 DiagrammaticEquations = "0.1.7"
 Distributions = "0.25"
 GeometryBasics = "0.4"
+IJulia = "1.26.0"
 JSON3 = "1"
 LinearAlgebra = "1"
 MLStyle = "0.4"

packages/algjulia-service/README.md

@@ -25,11 +25,22 @@ julia --project -e 'import Pkg; Pkg.instantiate()'
 
 ## Usage
 
-Navigate to this directory and run:
+Navigate to this directory and launch the Jupyter serving by running:
 
 ```sh
-jupyter server --IdentityProvider.token="" --ServerApp.disable_check_xsrf=True --ServerApp.allow_origin="http://localhost:5173"
+./jupyter_server.sh
 ```
 
 While the Jupyter server is running, the AlgebraicJulia service will be usable
-by CatColab served locally.
+by CatColab when served locally.
+
+## Compiling a Sysimage
+
+Precompiling dependencies like `CairoMakie.jl` and `OrdinaryDiffEq.jl` can be
+time-consuming. A **sysimage** is a file that stores precompilation statements,
+making future invocations of `AlgebraicJuliaService` and its dependencies
+immediate.
+
+To build a sysimage, run the Julia program `./make_sysimage.jl` as a script.
+This process may take upwards of five minutes or longer, depending on your
+machine.

packages/algjulia-service/jupyter_server.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+KERNEL_NAME="julia-1.11"
+#KERNEL_NAME="julia-ajaas-1.11"
+
+ORIGIN="http://localhost:5173"
+
+jupyter server \
+    --IdentityProvider.token="" \
+    --ServerApp.disable_check_xsrf=True \
+    --ServerApp.allow_origin="$ORIGIN" \
+    --ServerApp.allow_credentials=True \
+    --MultiKernelManager.default_kernel_name="$KERNEL_NAME"

packages/algjulia-service/make_sysimage.jl

@@ -0,0 +1,23 @@
+#!/usr/bin/env julia
+
+@info "Verifying PackageCompiler is installed globally"
+using Pkg; Pkg.activate(); Pkg.add("PackageCompiler")
+using PackageCompiler
+
+@info "Activating sysimage environment"
+Pkg.activate(@__DIR__)
+
+@info "Creating the sysimage. This may take a while..."
+sysimg="AlgebraicJuliaService.so"
+create_sysimage(["AlgebraicJuliaService"], sysimage_path=sysimg,
+                precompile_execution_file="sysimage_precompile.jl")
+sysimg_path=joinpath(@__DIR__, sysimg);
+
+@info "Adding $sysimg_path to IJulia kernel"
+Pkg.activate(); Pkg.add("IJulia")
+using IJulia
+
+installkernel("Julia AJaaS", "--project=@.", "--sysimage=$sysimg_path")
+
+@info "Done!"
+exit()

packages/algjulia-service/sysimage_precompile.jl

@@ -0,0 +1,2 @@
+import AlgebraicJuliaService
+include(joinpath(pkgdir(AlgebraicJuliaService), "test", "runtests.jl"))

packages/frontend/src/stdlib/analyses/jupyter.ts

@@ -39,9 +39,14 @@ export function createKernel(
 
 /** Create a Julia kernel in a reactive context. */
 export function createJuliaKernel(serverOptions: ServerSettings) {
+    // XXX: How do we know...
+    // - which Julia version to use?
+    // - whether to use the standard kernel or one with our custom sys image?
+    // For now, we are omitting the kernel name completely and thus assuming
+    // that the correct default kernel has been set on the Jupyter server.
+    // Obviously this approach will not extend to multiple languages.
     return createKernel(serverOptions, {
-        // XXX: Do I have to specify the Julia version?
-        name: "julia-1.11",
+        //name: "julia-1.11",
     });
 }