Since this project uses Docker you can run it on a range of operating systems; Windows, Linux, Mac, etc.
This document will provide details for users of Windows (Docker Desktop) and Linux (Docker CE).
To run Docker Desktop on a Windows machine it is recommended that you use the WSL 2 backend.
Prerequisites:
WSL 2 is the recommended backend for Docker Desktop but it also allows Linux commands to be run natively:
WSL 2 is incredibly useful and brings the power of the Linux command line to Windows.
To gain the full benefits of WSL 2 you will will need to install a Linux distribution on your Windows machine.
The installation can be done via the Microsoft store; Ubuntu is the distribution of choice for this project.
To run Docker on a Windows machine you need Docker Desktop, included in the free subscription plan Docker Personal.
To install Docker Desktop, simply follow the installation instructions provided by Docker.
To run Docker on a Ubuntu machine you need Docker installed; typically Docker CE (Community Edition).
Simply follow the installation instructions provided by Docker. Installing using the Docker repository is the recommended approach.
Once Docker is installed and the “hello-world” example runs via “sudo”, follow the described steps to manage Docker as a non-root user.
Once Docker is installed and can be managed as a non-root user, Ubuntu is ready for the SSE Results application.
Although Docker will automatically “pull” the required image layers when running the application image it may be preferable to issue a pull command manually.
$ docker pull logiqx/sse-results
You may need to install git:
$ sudo apt-get update
$ sudo apt-get install git-all
Clone the project repository to create a local copy:
$ git clone git@github.com:Logiqx/sse-results.git
If the git command fails, you may not have set up a password protected SSH key. You may therefore prefer to use HTTPS instead:
$ git clone https://github.com/Logiqx/sse-results.git
Note: The project repository is pretty small and was approximately 48MB in size on 20 Feb 2022.
The test reports using historical WSW data can be generated by running a shell script from within the project root:
$ cd sse-results
$ bin/results.sh
To gain an insight into what occurs during the processing, reading the diagnostics section is highly recommended.
Note: It usually takes around 10 seconds in total to run all of the WSW reports for 1998 to 2021.