THIS REPOSITORY HAS BEEN ARCHIVED PLEASE USE THE OFFICIAL MNE-NIRS and MNE-DOCKER REPOSITORIES https://github.com/mne-tools/mne-nirs

MNE-NIRS Docker Container with Jupyterlab

This provides a docker container for running MNE-Python and MNE-NIRS with full 3d visualisation capabilities. It is also used as the basis for a binder image. Binder allows you to run notebooks in the cloud with no local installation. This image is built on top of the official MNE image here: https://github.com/mne-tools/mne-docker.

Practically, this allows you to run MNE-NIRS code on your computer without installing python or any packages. You simply run the command below and a notebook server will be started with all appropriate packages available. This is a great way to get started using MNE-NIRS.

Usage

To start a jupyter lab server with the latest image (and allow access from any IP address) use:

docker run -p 8888:8888 ghcr.io/rob-luke/mne-nirs/image:latest jupyter-lab --ip="*"

If you have been using a previous version and want to update to the latest, then pull the latest image using:

docker pull ghcr.io/rob-luke/mne-nirs/image:latest

If you wish to mount a local directory (useful for processing your own files and scripts) on a *nix or mac:

docker run -p 8888:8888 -v `pwd`:/home/mne_user ghcr.io/rob-luke/mne-nirs/image jupyter-lab --ip="*"

Or on windows:

docker run -p 8888:8888 -v %cd%:/home/mne_user ghcr.io/rob-luke/mne-nirs/image jupyter-lab --ip="*"

Versions

Tags will be built according to the versioning of MNE-NIRS. For example, to use MNE-NIRS version v0.0.6 run:

docker run -p 8888:8888 ghcr.io/rob-luke/mne-nirs/image:v0.0.6 jupyter-lab --ip="*"

Development

There are several github actions that help with deployment and testing:

• main.yml ensure the docker image builds and runs tests against it.
• release.yml releases a latest image.
• release_vX_Y_Z.yml releases a vX.Y.Z version of the image.
• tags.yml releases a version when a tag is made and also a latest version (use the manual release options instead).