Shamrock install (Docker)

Install docker

Linux (debian)

See Docker documentation.

For convenience you can add your user to the docker group (to avoid having to use sudo every time). See post installation steps.

sudo groupadd docker
sudo usermod -aG docker $USER

MacOS

brew install --cask docker
open /Applications/Docker.app

Starting Shamrock docker container

Shamrock CI automatically generates the ghcr.io/shamrock-code/shamrock:latest-oneapi docker container with the last commit. It is convenient if you want to test it right away but do not want to clone/compile and so on…

Note however that while convenient it prevents you from displaying windows, so a jupyter notebook, terminal apps, and normal runs are fine but you can not display a matplotlib window this way.

docker run -it --platform=linux/amd64 ghcr.io/shamrock-code/shamrock:latest-oneapi