Installation¶
You need to install wordslab on each host machine on which you want to create, start and stop a local virtual machine.
You can manage all your cloud virtual machines from a single wordslab manager installation.
You can install wordslab manager on:
- Windows 10+
- Linux - Ubuntu 18.04+
- macOS - Catalina+
You don't need to be an administrator or to have root/sudo privileges to install and use wordslab manager, or even to create a local virtual machine.
But you may need admin privileges to install some prerequisites on the machine (see below).
The wordslab manager installation and its data always stays confined to the current user account.
wordslab manager will check and install for you all the necessary prerequisites.
OS support and prerequisites¶
Prerequisites to create a local virtual machine
- Windows 10 version 1903+ x64
- 10 GB of free disk space
- Admin privileges are only needed to enable Windows Subsystem for Linux
- Ubuntu version 18.04+ x64
- Not tested but should also work if qemu is installed :
- Arch: pacman -S qemu
- Debian/Ubuntu: apt-get install qemu
- Fedora: dnf install @virtualization
- Gentoo: emerge --ask app-emulation/qemu
- RHEL/CentOS: yum install qemu-kvm
- SUSE: zypper install qemu
- 10 GB of free disk space
- Admin privileges are only needed to install cpu-checker qemu qemu-utils qemu-kvm
- macOS 10.15+ x64
- 10 GB of free disk space
- Admin privileges are only needed to install homebrew
Prerequisites to use a GPU in local virtual machine
- Nvidia GPU with Pascal (GTX 1050) and later GPU architecture
- Windows 10 version 21H2+ (build 19044+) or Windows 11 x64
- Nvidia driver version >= 496.76 (16 nov 2021)
- Windows Subsystem for Linux Kernel version 5.10.16.3 or later
- GPU sharing between host and guest OS on Linux is not supported
- GPU sharing between host and guest OS on macOS is not supported
Installation instructions¶
You can find the changelog for all wordslab manager releases in the Github repository: https://github.com/wordslab-org/wordslab/releases.
To download and install wordslab manager, open a terminal and copy the installation commands below.
Installation commands
set installdir=%HOMEPATH%\wordslab
mkdir %installdir%
curl -L -o %installdir%\wordslab-win-x64.zip https://github.com/wordslab-org/wordslab/releases/download/v0.9.2/wordslab-win-x64.zip
tar -x -f %installdir%\wordslab-win-x64.zip -C %installdir%
del %installdir%\wordslab-win-x64.zip
cd %installdir%
wordslab version
installdir=$HOME/wordslab
mkdir $installdir
curl -L -o $installdir/wordslab-linux-x64.tar.gz https://github.com/wordslab-org/wordslab/releases/download/v0.9.2/wordslab-linux-x64.tar.gz
tar -xf $installdir/wordslab-linux-x64.tar.gz -C $installdir
rm $installdir/wordslab-linux-x64.tar.gz
cd $installdir
./wordslab version
installdir=$HOME/wordslab
mkdir $installdir
curl -L -o $installdir/wordslab-osx-x64.tar.gz https://github.com/wordslab-org/wordslab/releases/download/v0.9.2/wordslab-osx-x64.tar.gz
tar -xf $installdir/wordslab-osx-x64.tar.gz -C $installdir
rm $installdir/wordslab-osx-x64.tar.gz
cd $installdir
./wordslab version
Quick start¶
If your goal is to install the built-in notebooks app, you can execute a single command:
wordslab install notebooks
This command will: - check and prepare your machine will all the prerequisites - create a local virtual machine called "dev" with the recommended configuration - download and deploy the "notebooks" app for a GPU environment
The command line will print the URL at which you will be able to access your Jupyterlab environment after a few minutes of patience.
You can then use the following command to monitor, start and stop your virtual machine from a web UI:
wordslab manager