Windows installation

This section provides instructions for the installation of SciCell++ on a Windows system. We tested these instructions on Windows 10 but we (hopefully) expect them to work on recent versions too. Once finished this section you should continue with the Starting SciCell++ on Windows document.

Overview

  1. Enable virtualisation on Windows

  2. Install Docker Desktop

  3. Install GitHub Desktop

  4. Troubleshooting

Enable virtualisation on Windows

The following instructions are based on this YouTube video and the official webpage for WSL2 installation for Windows 10.

  1. Look for bios on the windows search tool and select the Change advanced startup options option.

    ../../_images/01.png

  2. On the Advanced startup section click on the Restart now button.

    ../../_images/02.png

  3. Click on Troubleshoot, then on Advanced options, followed by UEFI Firmware Settings and finally click on the Restart button.

  4. Once your computer has launched you may see a screen similar to the one below (the specific screen depends on your vendor’s machine). Look for an Advanced Menu and make sure that Virtualization Technologies are enabled. Save your changes and restart your computer. You may have a similar option if you are using a different processor brand.

    ../../_images/03.jpg

  5. Once your computer has restarted look for powershell on the search bar, right-click on the Windows PowerShell option and select Run as administrator.

    ../../_images/04.png

  6. On the command line type (or copy-paste) the following and wait for completion.

    dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

  7. Check your Windows version by typing the winver command in the Run dialog, press Windows Key+R to open the Run dialog.

    ../../_images/05.png

  8. In the About Windows dialog check you fullfill the following requirements (as indicated in Step 2 on this webpage):

    • For x64 systems: Version 1903 or higher, with Build 18362 or higher.

    • For ARM64 systems: Version 2004 or higher, with Build 19041 or higher.

  9. Once again open a Windows PowerShell with administrative rights, type (or copy-paste) the following and wait for completion.

    dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

  10. Download and install the WSL2 Linux kernel update package for x64 machines as indicated on Step 4 on this page

../../_images/07.png

  1. Once more open a Windows PowerShell with administrative rights, type (or copy-paste) the following and wait for completion.

wsl --set-default-version 2

  1. Install a Linux distribution as indicated on Step 6 on this page. We recommend to install the latest Ubuntu available distribution (20.04 LTS or 18.04 LTS). Do not forget to launch and set a password for your newly installed linux distribution.

    ../../_images/08.png

Install Docker Desktop

  1. Download Docker Desktop for windows (at the writing of this document lastest version was 3.5.2).

  2. Install Docker Desktop with the default options.

    ../../_images/011.png

  3. Once the installation process finish you need to restart your computer. Click on the Close and restart button.

  4. (Optional) Open docker, go to Settings>General and make sure the Use the WSL2 based engine check box is ticked.

Install GitHub Desktop

  1. Download GitHub Desktop (you will need lo sign up on GitHub).

  2. Install GitHub Desktop and select the Sign in to GitHub.com option.

  3. In the browser use your GitHub credentials to login. If prompted, select the open on GitHub desktop option.

  4. On the Configure Git dialog select the Use my GitHub account name and email address option and click on Finish.

  5. Select the Clone a repository from the Internet... option.

  6. Look for the scicellxx repository and select it. Use the default location to clone the repository or choose one in your local drive (make sure to remember this location since you will need it to use SciCell++).

  7. Click on the Clone button and wait for completion.

  8. Create a new branch on the Github Desktop application. Go to the menu Branch and select New branch.... This will open a dialog where you specify the new branch name, use your name in lowercase as the branch name. For example john_cool.

    ../../_images/012.png

    Note

    Whenever you start to work with SciCell++ you should ensure that you are working on your own branch. In case you are on a different branch you can switch to your branch (or any other) by selecting it on the popup menu (current branch).

    Note

    Any commits to SciCell++ must be done to your own branch, so make sure the Commit to .. button spells your branch name.

Troubleshooting