You can double-click the launcher in the DL4MicEverywhere folder (which has the same name as your system, e.g., Windows_launch for Windows operating systems) to launch the GUI, but it also does some requirements checking. At the beginning of the process, the launcher checks if the requirements listed below are installed; otherwise, they are installed automatically. It can happen that the installation is not successfully done; in that case, please follow the guidelines provided on this page.
- Docker installed on your system.
- For GPU usage - NVIDIA GPU + CUDA drivers.
- If you want to run the graphical user interface (GUI), Tcl/Tk must be installed on your computer.
The installation guidelines will be different depending on your operative system. Select the operative system on you computer and follow the indicated steps:
On Windows:
Windows operating systems require a slightly more complicated installation process. Also, beware there might be differences between Windows 10 and 11.
- Install Docker Desktop.
- Install Ubuntu inside WSL.
- Install TCL/TK in WSL's Ubuntu.
- WSL (Windows Subsystem for Linux) - Pre-installed on most Windows 10/11 systems, otherwise it is available on the Microsoft store.
- Install and/or update all the GPU NVIDIA drivers, cudatoolkit, and cuDNN necessary for your GPU.
Firstly, Docker Desktop needs to be installed on your computer. Follow the official guidelines: https://docs.docker.com/desktop/install/windows-install/:
- During installation tick the recommended WLS2 option.
- To finalize the installation Restart the computer.
Open a Command Line (cmd.exe) or PowerShell window and run:
wsl --install -d Ubuntu
This will install Ubuntu inside WSL.
Once the installation ends it will ask for a username and a password. This is not necessary, exit the installation by using Ctrl+C or by closing the window.
Re-open the Command Line or PowerShell window and run the command again, if the installation was sucessfull you should see the following message:
Run the following command in the Command Line or PowerShell window to check what is the current default configuration.
wsl --list --verbose
The one with * is the default configuration.
If it is not Ubuntu, it can be changed by using the command:
wsl --set-default Ubuntu
TCL/TK is required for the graphical user interface (GUI) of DL4MicEverywhere, and it must be installed inside WSL's Ubuntu.
This requires running the following commands in the Command Line or PowerShell window:
wsl sudo apt-get -y update
wsl sudo apt-get -y install tk
Now TCL/TK should be installed inside WSL's Ubuntu.
To check if TCL/TK is correctly installed run:
wsl wish
This should open a new window named Wish. If it fails repeat the previous steps again or create a Issue letting us know your problem.
On Linux:
Firstly, Docker Desktop needs to be installed on your computer. Follow the official guideline: https://docs.docker.com/desktop/install/linux-install/
The only requirement to use the graphical user interface (GUI) is to have Tcl/Tk installed on your computer.
Most Unix / Linux operating system distributions include Tcl and Tk. If not already installed, use your system's package manager to install the appropriate packages. For Ubuntu, use the following commands:
sudo apt-get -y update
sudo apt-get -y install tcl
sudo apt-get -y install tk
On Mac:
Firstly, Docker Desktop needs to be installed on your computer. Follow the official guideline: https://docs.docker.com/desktop/install/mac-install/
The only requirement to use the graphical user interface (GUI) is to have Tcl/Tk installed on your computer.
Most Mac OS X operating system distributions include Tcl/Tk. If not already installed, you will receive an error similar to the following:
DEPRECATION WARNING: The system version of Tk is deprecated and may be removed in a future release. Please don't rely on it. Set TK_SILENCE_DEPRECATION=1 to suppress this warning.
you can install or update the appropriate packages in two different ways:
-
Option 1: Using Homebrew: Reinstall your tcl-tk packages
brew uninstall tcl-tk brew install tcl-tkNote: If you don't have the
brewcommand, install Homebrew by running the following command in your terminal:/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -
Option 2: Using a package installation:
Go to https://www.tcl.tk/software/tcltk/ and click on the Active Tcl link:
In this case, as you are using macOS, click on the macOS option:
Then, you can create an account, or continue to download without an account, to be able to download the installation file:
Afterwards this window will be shown. Don't worry. Click on View all Available Builds:
and then click on the Download button to get the
.pkgfile:
Then, find the package that you have downloaded:
and after double-clicking, an installation window will pop up. Click on Continue to start the installation:
Click on Continue to go to the License step:
Click on Agree:
Click on Install to start the installation:
The installation has been completed, click on Close and everything should be ready.
Once you have followed all these steps, you are ready to run DL4MicEverywhere - the last step to continue is downloading the DL4MicEverywhere repository on the User Guide.