Basic process:

1. Enable hardware assisted virtualization.
2. Set up WSL (Windows Subsystem for Linux)
3. Install Linux into WSL
4. Download and compile Sage
5. Configure JupyterLab
6. Make it easy to start from windows

Enable hardware assisted virtualization

WSL requires that your system supports hardware assisted virtualization (which pretty much all modern systems do), there are 3 things that you need to get it working:

• The CPU must support it
• The motherboard must support it.
• You need to enable it in the EFI (or BIOS)

This article takes you through getting everything sorted out:

https://support.bluestacks.com/hc/en-us/articles/115003174386-How-to-enable-Virtualization-VT-on-Windows-10-for-BlueStacks-4

Set up WSL 2

Follow this guide: https://docs.microsoft.com/en-us/windows/wsl/install-win10

Install and configure Linux:

1. Go to the Microsoft store and install Ubuntu.

Note: If you already have Ubuntu installed, I’d recommend you follow these instructions to set up a separate, clean install for sage: https://hfakhraei.github.io/Install-multiple-instance-of-same-Linux-Distribution-on-WSL

2. Start Ubuntu from the start menu. A command window should pop up.
3. Run these commands to update Ubuntu:

    sudo apt update
    sudo apt upgrade

4. Reboot by going (in Windows) to Services and restarting the LxssManager. You can also shut down all running WSL instances using the command wsl --shutdown in the Windows command prompt or Powershell.
5. If necessary upgrade to the latest release: https://linuxconfig.org/how-to-upgrade-ubuntu-to-20-10

Set up Sage

These instructions are a simplified version of the official documentation: https://doc.sagemath.org/html/en/installation/source.html

1. Start Ubuntu – All the commands in this section should be run on the Ubuntu installation.
2. Install the packages we need to have ready in advance:

sudo apt install bc binutils bzip2 ca-certificates cliquer cmake coinor-cbc coinor-libcbc-dev curl default-jdk dvipng eclib-tools fflas-ffpack ffmpeg flintqs g++ gcc gfan gfortran git glpk-utils gmp-ecm imagemagick latexmk lcalc libatomic-ops-dev libavdevice-dev libboost-dev libbraiding-dev libbrial-dev libbrial-groebner-dev libbz2-dev libcdd-dev libcdd-tools libcliquer-dev libcurl4-openssl-dev libec-dev libecm-dev libffi-dev libfile-slurp-perl libflint-arb-dev libflint-dev libfreetype6-dev libgc-dev libgd-dev libgf2x-dev libgiac-dev libgivaro-dev libglpk-dev libgmp-dev libgsl-dev libiml-dev libisl-dev libjson-perl liblfunction-dev liblrcalc-dev liblzma-dev libm4rie-dev libmongodb-perl libmpc-dev libmpfi-dev libmpfr-dev libnauty-dev libncurses5-dev libntl-dev libopenblas-dev libpari-dev libpcre3-dev libperl-dev libplanarity-dev libppl-dev libpython3-dev libreadline-dev librw-dev libsqlite3-dev libssl-dev libsuitesparse-dev libsvg-perl libsymmetrica2-dev libterm-readkey-perl libterm-readline-gnu-perl libxml2-dev libxml-libxslt-perl libxml-writer-perl libz-dev libzmq3-dev libzn-poly-dev m4 make nauty ninja-build openssl palp pandoc pari-doc pari-elldata pari-galdata pari-galpol pari-gp2c pari-seadata patch perl pkg-config planarity ppl-dev python3 python3-distutils r-base-dev r-cran-lattice sqlite3 sympow tachyon tar texlive texlive-xetex xcas xz-utils yasm

3. Download and extract the source tarball into a subfolder of your home directory

cd ~
wget http://www.mirrorservice.org/sites/www.sagemath.org/src/sage-9.2.tar.gz
tar xvf sage-9.2.tar.gz

4. Start building

cd sage-9.2/
./configure
make

This will take a long time (3 hours on my system)

5. Test sage

./sage

You should get a prompt that looks like this:

┌────────────────────────────────────────────────────────────────────┐
│ SageMath version 9.2, Release Date: 2020-10-24                     │
│ Using Python 3.8.6. Type "help()" for help.                        │
└────────────────────────────────────────────────────────────────────┘
sage:

6. Type exit and press enter to leave.

7. Make the command available from anywhere on this ubuntu system – edit ~/.bashrc and add this line:

alias sage=~/sage-9.2/sage

8. Close ubuntu then reopen it.
9. Try typing sage and verify that it starts.

JupyterLab

1. Install Jupyter Lab and it’s extras:

sage -i jupyterlab_widgets

This also involves compliation from source, so will take a while.

2. When it’s done, try starting the jupyterlab notebook like this:

sage --notebook jupyterlab

You might notice a problem – the list of files only includes those on your linux machine – you probably want the ones on your windows computer. You can do this by navigating to where the windows files are mounted in linux.

3. Try it (fill in your windows username instead of the square brackets):

cd /mnt/c/Documents\ and\ Settings\[your windows username]
sage --notebook jupyterlab

The list of files should now be the ones in that folder on your windows machine.

4. Lets wrap this all in a script for convenience – Create a file called ~/sage_nb.sh and put these lines into it:

#!/bin/bash
cd /mnt/c/Documents\ and\ Settings/[your windows username]
/home/[your linux username]/sage-9.2/sage --notebook jupyterlab

5. We need to make it executable – ie. so linux will run this file like it would run a program:

chmod ug+x sage_nb.sh

6. Now go back to your home directory and try it again:

cd ~
./sage_nb.sh

The JupyterLab server should start, showing your windows files in the browser.

Create windows shortcut

This is a final nicety that lets you start the JupyterLab server in one click:

1. Open Windows explorer, and type %APPDATA%\Microsoft\Windows\Start Menu\Programs
2. Make a copy of any of the program icons – we’ll customise it to do what we want
3. Right-click, and choose properties.
4. On the General tab:
   • Change the name to whatever you want.
5. On the Shortcut tab:
   • Change Target to: ubuntu.exe run ~/sage_nb.sh
   • Change Start in to: %USERPROFILE%
   • Change Run to: Minimised
   • Change the icon if you want – there are plenty of pieces of software that can create a .ico icon file one from an image file.
6. Now hit the start button or key and type the name you gave it. it should appear in the list, and should load the server and fire up your browser when you click on it.

Software versions:

This is what I used when I wrote this post – you might get different results if your versions are significantly different.

• Windows 10 Pro Version 2004 (OS Build 19041.264)
• Ubuntu 20.10 (Originally installed 20.04 as 20.10 was not available in the Windows Store)
• Sage 9.2

If you haven’t done already, take a look at my previous post to use wsltty to view the local WSL installation, which is then used to ssh into a remote box.

For the purpose of this explanation the client is the machine you’re sitting at, and the server is the remote machine you’re connecting to.

First, we need to get SSH X11 Forwarding working. This would normally be used for running graphical applications, but we’re just using it for the clipboard feature.

Server Configuration

You should have these lines uncommented in /etc/ssh/sshd_config

X11Forwarding yes
X11DisplayOffset 10
X11UseLocalhost no

When you’re done restart the ssh daemon, on my (Debian) system the command is this:

sudo systemctl restart ssh

If you’re running a firewall on the server you need to enable loopback. I’m using iptables, so this is how I’d do it:

sudo iptables -I INPUT -i lo -j ACCEPT
sudo iptables -I OUTPUT -o lo -j ACCEPT
su -
iptables-save > /etc/iptables/rules.v4
exit

Client configuration

From within WSL (but not ssh’d into a remote system), Install xauth and xterm:

sudo apt install xauth xterm

A big thanks to this video for help with the next section: youtube.com/watch?v=_MgrjgQqDcE

In Windows, download and install VcXsrv https://sourceforge.net/projects/vcxsrv/

Find XLaunch in the start menu and run it.

On the first screen choose Multiple Windows and set the Display number to 0:

Choose Start no client on the next page:

Make sure Clipboard is turned on

Press Save configuration.

Type shell:startup in the address bar and hit enter – this will take you to a special folder – files saved here will run when a user logs in. The filename should be pre-populated as config.xlaunch. That’s OK so hit Save, and then Finish in the previous window.

Finally, go back to WSL. This command tells your local WSL (the client) where to find the display. SSH uses that information when you link to the remote computer (server).

export DISPLAY=localhost:0

You can also save this line into ~/.bashrc on the client to load it every time WSL starts.

Connect and Test

In WSL, connect to the server with a slightly modified command:

ssh -Y joebloggs@remotelinuxcomputer.example.com

The -Y tells ssh you want to link the server to the VcXsrv software, so the server can display things on the client’s screen.

Let’s test with xeyes

sudo apt install xeyes
xeyes

A pair of eyes should appear on your screen, and follow the mouse around.

Put it to use!

So, what we have now is that anything that goes onto the Linux system clipboard (xclip) should end up on the Windows clipboard too. Lets give it a try. Pipe some data to xclip:

echo "I'm copied, paste me!" | xclip -i

Now try pasting that into a text editor on windows.

Next, copy some text in windows, then go back to your ssh session and type:

xclip -o

The text you copied should appear on a new line in the terminal.

The real power of this comes when combined with terminal applications that are aware of the system clipboard. For me, I wanted to copy from vim in an ssh session, and then paste into windows. If you’re using a version of vim with enough features (I use vim-gtk), all you have to do is add this to your ~/.vimrc:

" Yank goes to system clipboard, to aid with WSL copy/paste
set clipboard=unnamedplus

Now, anything copied by the yank commands ends up in the windows clipboard too.

Here’s how to set it up.

Install Windows Subsystem for Linux (WSL):

1. Open Powershell as an administrator
2. Enter this command:
   Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
3. When it’s done, restart your computer.

Install Linux (on WSL)

I recommend Debian – it’s well supported by the community, and a pretty lightweight install compared to some of the other choices.

For the local windows store

1. Open the Windows Store
2. Search for “Debian”
3. Click on Get
4. Click on Install

Once it’s installed:

1. Find and click on the Debian app in your start menu
2. Wait for a moment, then set up a username for this local installation of linux. It’ll be slightly more convenient if you use the same username you have on your remote linux machines.
3. Exit the terminal: type:
   exit
   and press enter.

This info came from https://docs.microsoft.com/en-us/windows/wsl/install-win10

Install WSLtty

1. Go to https://github.com/mintty/wsltty/releases/latest
2. Choose the right release for your system – unless you have a fairly old computer it’ll be the one ending in “x86_64.exe”
3. Download and install.
4. This app isn’t digitally signed in a way approved by Microsoft, so a warning will pop up (“Windows protected your PC”). Click More info then Run anyway.

Run and connect!

Mintty should have installed a shortcut called “WSL Terminal” with the linux penguin icon, click on it and you’ll get a black terminal windows with prompt in the top left: [your unix username]@[computer name]:~$

Let’s get your local linux system up to date:

1. Type sudo apt update then press enter.
2. Type in your local linux password (that you created earlier)
3. sudo apt upgrade, then press y and enter when asked if you want to continue
4. It may take a little while, depending on the speed of your pc and internet connection.
5. Finally lets install ssh:
   sudo apt install ssh

Now we can connect to a remote linux computer:

If the username on the remote computer is the same as the one you created earlier, the command is:
ssh remotelinuxcomputer.example.com or ssh 192.168.2.1, when you put in the computer’s name or ip address.

If the username is different, no problem, do this:
ssh joebloggs@remotelinuxcomputer.example.com
or
ssh joebloggs@192.168.2.1

In either case, you will probably get a warning about “the authenticity of the host xxxxx can’t be established”. Don’t worry, just type yes, then enter you password for the remote computer, and you’re in!

One final tip

If ssh into remote computers is all your do with this, then log out, the login command will be remembered by the shell, even if you reboot.
Next time you open the WSL terminal, press the “Up” as many times as you need to scroll through the command history and find the one you wanted.