This repo contains the material that will be displayed during neXtSIM workshop taking place in Brown University, Providence, 2025 June 26-27. Click on the link to access the notebook corresponding to the session :
- Introduction to neXtSIM and use cases - Einar Olason
- Data assimilation in neXtSIM with NEDAS - Yue (Michael) Ying, Ali Aydogdu, Yumeng Chen
- Data exploration: Antarctic neXtSIM - Christopher Horvat
- Data exploration: wave-ice coupled neXtSIM-WW3 - Guillaume Boutin
- Data exploration: kilometer-scale sea-ice-ocean coupled simulations with a brittle rheology - Stéphanie Leroux
- neXtSIM: structure and design principles - Timothy Spain
- Use cases run on GPU - Robert Jendersie
- How to implement a new parameterization in neXtSIM - Timothy Spain
Here are the instructions on how to run this material on your own laptop.
Prerequisites : You will need a recent version of docker on your machine, if you do not have it already you can install it from here : https://docs.docker.com/get-started/get-docker/ You will also need around 10Gb of storage for the docker image and the data it contains.
You need 2 ingredients :
- the notebooks
- the computing environment
First step : The notebooks are stored in this very repo, download them with :
git clone https://github.com/sasip-climate/notebooks-nextsim-workshop2025.gitIt will create a directory called notebooks-nextsim-workshop2025
Second step : The docker image contains the python libraries, a compiled version of nextsimdg and other tools and the data required to run the notebooks. It can be downloaded with this command (after having started the docker Desktop) :
docker run --rm -v /YOURPATH/notebooks-nextsim-workshop2025:/home/notebooks-nextsim-workshop2025 -p 8888:8888 quay.io/auraoupa/nextsim-workshop:2ebf5817a75f where YOURPATH must be replaced by the absolute path on your laptop leading to the notebooks-nextsim-workshop2025 directory created by the first step
A jupyterlab is now deployed, you just have to open in a browser the given adress http://127.0.0.1:8888/lab?token=... with your assigned token
If the command returns WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested, try this alternative command:
docker run --rm -v /YOURPATH/notebooks-nextsim-workshop2025:/home/notebooks-nextsim-workshop2025 -p 8888:8888 ghcr.io/sasip-climate/workshop:latest If the command returns docker: Cannot connect to the Docker daemon at unix:///Users/alberta/.docker/run/docker.sock. Is the docker daemon running?, you just need to launch the docker desktop !
You should have this jupyterlab session open in a browser (learn how to work in a jupyterlab framework here):
You can now navigate in the notebooks repository (left panel) and open the Welcome.ipynb notebook :
After closing your browser, you can relaunch at any time by re-executing the command docker run --rm -v /YOURPATH/notebooks-nextsim-workshop2025:/home/notebooks-nextsim-workshop2025 -p 8888:8888 quay.io/auraoupa/nextsim-workshop:2ebf5817a75f, it will take much less time since the docker image is now on your computer.
At the start of the workshop, you will have to get the latest version of the notebooks by doing a git pull while inside the notebooks-workshop2025 repository
You can use binder here : https://mybinder.org/v2/gh/sasip-climate/docker-image-nextsim-workshop/data Warning it will be slow !
While inside the binder, launch a terminal and clone the notebooks there : git clone https://github.com/sasip-climate/notebooks-nextsim-workshop2025.git