darpa-askem / askem-julia

Standard ASKEM Julia Environment

This repo specifies packages developed or used by the ASKEM program. Additionally, this environment can be installed on a local machine or Docker and provides optional hosting for IJulia and Pluto.

Installation

Local

./install.jl

Docker

docker build . -f docker/Dockerfile -t askem-julia:latest

Usage

Local

To use the basic (slower) mode, simply run:

julia # enter the Julia Repl
julia> ] activate @askem

If you wish to start using the sysimage (optimized/faster) mode:

julia --project="@askem" --startup=no --color yes -J{$HOME}/.julia/environments/askem/ASKEM-Sysimage.so

Docker

docker run -p 8888:8888 askem-julia

Changes

Any PR to main must change the version in Project.toml. If x.y.z is our version scheme, then do one of the following

• Increase x if you update or remove
• Increase y if you add a package
• Increase z if there's some other change not related to Project.toml or Manifest.toml

askem-julia's Issues

Oceananigans breaks the sysimage produced by `install.jl`

Oceananigans.jl is currently excluded from building in ASKEM-Sysimage.so because an

InitError(mod=:PMIx_jll, error=ErrorException("could not load library "/usr/local/julia/artifacts/b64ad2ff5bdc8b41a59009d2b5547838cfde4f5d/lib/libpmix.so"

is thrown on REPL start if Oceananigans is in the sysimage. Note that libpmix.so exists in the path specified above.

We want to put Oceananigans back in the sysimage now because it has a using time of many minutes.

Notes on environment:
I tried this both on my Linux machine locally and in Docker using docker/Dockerfile.