## page was renamed from Nottingham2024/Installation
== Installing ScrumPy ==
=== Pre-requisite: ===
These instructions assume that you have successfully installed WSL or a virtual machine, as described in the [[Meetings/Nottingham2024/PreArrival|pre-arrival instructions]]. If for some reason this hasn't been possible, please consult one of the instructors.

=== Downloading the software: ===
Open a shell in your linux environment

Create a directory into which we will download the ScrumPy source-code:

{{{#!highlight bash
$ mkdir ScrumPyInstall
}}}
and make this directory your current working directory:

{{{#!highlight bash
$ cd ScrumPyInstall
}}}
Now we can download the source-code archive:

{{{#!highlight bash
ScrumPyInstall$ wget https://gitlab.com/MarkPoolman/scrumpy/-/archive/master/scrumpy-master.tar.gz
}}}
and then unpack it:

{{{#!highlight bash
ScrumPyInstall$ tar zxf scrumpy-master.tar.gz
}}}
Check that it's worked:

{{{#!highlight bash
ScrumPyInstall$ ls
scrumpy-master.tar.gz
mark@Ryzen7-1:~/ScrumPyInstall$ tar zxf scrumpy-master.tar.gz
mark@Ryzen7-1:~/ScrumPyInstall$ ls
scrumpy-master  scrumpy-master.tar.gz
mark@Ryzen7-1:~/ScrumPyInstall$ ls scrumpy-master
BuildLibs.py  debian11.py  install_conf.py  ScrumPy      testing      Update.py
BuildRel.py   debian12.py  install.py       ScrumPy.e4p  Ubuntu20.py
CHANGELOG     Fedora38.py  LICENSE          synfromin    Ubuntu22.py
config.txt    INSTALL      README
}}}
=== Installing the Software ===
Having downloaded and unpacked the archive, we can now install the software. Do do this, we must assume root (aka ''admin'') privileges:

{{{#!highlight bash
mark@Ryzen7-1:~/ScrumPyInstall$ sudo bash
mark@Ryzen7-1:~/ScrumPyInstall#
}}}
Note the change of prompt from $ to # to remind you of your elevated privileges. All that remains is to cd into the source code archive, and run the installer:

{{{#!highlight bash
mark@Ryzen7-1:~/ScrumPyInstall# cd scrumpy-master
mark@Ryzen7-1:~/ScrumPyInstall/scrumpy-master# python3 ./install.py
}}}
This will generate a lot of output, but once it ends, you should drop root privileges, cd out  of the archive directory, and then run ScrumPy:

{{{#!highlight bash
mark@Ryzen7-1:~/ScrumPyInstall# CTRL+D
mark@Ryzen7-1:~/ScrumPyInstall$ cd
mark@Ryzen7-1:~/$ ScrumPy3
}}}
This should bring up a window similar to the one shown below:

{{attachment:ScrumPyWindow.png}}

=== Note: ===
If you are already familiar with git:

{{{#!highlight bash
mark@Ryzen7-1:~/$git clone https://gitlab.com/MarkPoolman/scrumpy.git
}}}
And run the installation script.