Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.41 KB

README.md

File metadata and controls

67 lines (45 loc) · 2.41 KB
Raw

MNE-docker

This repository stores the files to create docker images capable of running MNE-Python. This repository also hosts the code and runs the github actions to build and release these images publicly.

Getting started

To download a notebook capable MNE docker image and launch a jupyter lab session run:

docker run -p 8888:8888 ghcr.io/mne-tools/mne-python-jupyter jupyter lab --ip="*"

Available Docker images

The repository contains several images:

  1. mne-tools/mne-python: contains a minimal MNE-Python installation that can run python scripts.
  2. mne-tools/mne-python-jupyter: adds jupyter lab to the base image.
  3. mne-tools/mne-python-plot: adds 2D and 3D plotting capabilities to the mne-python-jupyter image.

Several versions of the image are stored that correspond to different MNE-Python versions. This allows you to specify which version of MNE-Python you wish to run. Additionally, if you wish to use the latest development version, you can specify the main branch. For example:

  • mne-tools/mne-python:latest would use the latest released MNE-Python version, e.g. v0.23.0.
  • mne-tools/mne-python:0.23.0 would use the MNE-Python version 0.23.0.
  • mne-tools/mne-python:main would use the development version of MNE-Python.

Building images

Docker compose provides an easy way to building all the images with the right context

docker-compose build

# Just build one image e.g. notebook
docker-compose build notebook

Releasing

Github container repository

Images are automatically built and uploaded to the GitHub container repository.

For example, to run the MNE-Python version v0.23.0 image, with plotting capabilities, mount the local directory, and start up a notebook server run:

docker run -p 8888:8888 -v `pwd`:/home/mne_user ghcr.io/mne-tools/mne-python-plot:v0.23.0 jupyter-lab --ip="*"

Dockerhub

Building and releasing new image versions is done automatically via GitHub Actions. When new commits are pushed to the main branch images are built with the dev tag and pushed to Docker Hub.

When a new version of mne-python is released a PR should be raised to bump the versions in the Dockerfiles and then once that has been merged a new tag matching the mne-python version should be pushed. GitHub Actions will then build the images and push them with version tags and update latest too.