MacOS
Minimum System Requirements
- At least 3GB free space for neurodesktop base image
- An Intel Mac. M1/ARM Macs are not yet supported.
- Docker requirements. Details found under https://docs.docker.com/get-docker/
Quickstart
1. Install Docker
Install Docker from here: https://docs.docker.com/get-docker/
Open the Docker Desktop and Navigate to the Install Docker Desktop tab. Instructions found at https://docs.docker.com/desktop/install/mac-install/
Increase the Memory slider from 2.00 GB to 4.00 GB (or greater)
Increase Swap slider from 1GB to 2GB (or greater)
2. Run Neurodesktop
Use one of the following options to run Neurodesktop:
Option 1 (Recommended): Neurodesk-App
Instructions on installing and using the app: https://www.neurodesk.org/docs/getting-started/neurodesktop/neurodeskapp/
Option 2 (Advanced): Using Terminal
Create a local folder where the downloaded applications will be stored, e.g. ~/neurodesktop-storage
- Open a terminal, and type the following command to automatically download the neurodesktop container and run it
docker run \
--shm-size=1gb -it --privileged --user=root --name neurodesktop \
-v ~/neurodesktop-storage:/neurodesktop-storage \
-e NB_UID="$(id -u)" -e NB_GID="$(id -g)" \
-p 8888:8888 -e NEURODESKTOP_VERSION=2023-09-20 vnmd/neurodesktop:2023-09-20
If you get errors in neurodesktop then check if the ~/neurodesktop-storage directory is writable for all users. If it is not, run chmod a+rwx ~/neurodesktop-storage
- Once neurodesktop is downloaded, leave the terminal open and check which server neurodesktop running on (Avoid pressing CTRL+C).
- To access neurodesktop, open your web browser and navigate to one of the URLs shown in your terminal (e.g.
http://127.0.0.1:8888/lab?token=your_unique_token
).
If prompted, press on “Desktop Auto-Resolution” under “ALL CONNECTIONS”
If it is the first time you use Neurodesktop, wait until the desktop appears (it may take a few seconds). Otherwise, it should appear instantaneously.
Neurodesk is ready to use! See the tutorials page for advice on how to use Neurodesk.
Deleting neurodesktop:
When done processing your data it is important to stop and remove the container - otherwise the next start or container update will give an error ("… The container name “/neurodesktop” is already in use…")
Note
Note that any data that were saved outside of /neurodesktop-storage would be lost. Please make sure to move all your data to that folder before deleting neurodesktop.Click on the terminal from which you ran neurodesktop
Press control-C
Type:
docker stop neurodesktop
- Type:
docker rm neurodesktop
Using an RDP Client
Startup Neurodesktop using the following command:
docker run \
--shm-size=1gb -it --privileged --user=root --name neurodesktop \
-v ~/neurodesktop-storage:/neurodesktop-storage \
-p 3390:3389 -p 8888:8888 \
-e NEURODESKTOP_VERSION=2023-09-20 vnmd/neurodesktop:2023-09-20
Open your RDP client and connect to Computer localhost:3390
Use the following details to login if prompted
- username
- user
- password
- password
Using VNC
To enable VNC and disable RDP, startup Neurodesktop using the following command:
docker run \
--shm-size=1gb -it --privileged --user=root --name neurodesktop \
-v ~/neurodesktop-storage:/neurodesktop-storage \
-e VNC_ENABLE=true -p 8888:8888 \
-e NEURODESKTOP_VERSION=2023-09-20 vnmd/neurodesktop:2023-09-20
Using a VNC Client
Startup Neurodesktop using the following command:
docker run \
--shm-size=1gb -it --privileged --user=root --name neurodesktop \
-v ~/neurodesktop-storage:/neurodesktop-storage \
-e VNC_ENABLE=true -p 5901:5901 -p 8888:8888 \
-e NEURODESKTOP_VERSION=2023-09-20 vnmd/neurodesktop:2023-09-20
Open a VNC Client and connect to port 5901