Software installation

In the following a brief overview on the software installation procedure is given. For troubleshooting, see the troubleshooting directory.

Installation order

It should be noted that the installation order and the correct fulfillment of the needed software requirements are important. This means:

Do not install the software components in a different order then the one described here. You might miss some dependencies.
The installation procedure was only tested on Ubuntu 18.04 LTS. If you try any other operating system or version, you might run into problems, which are not part of this documentation.
When you change your .bashrc file, do not forget to source it or just restart your computer.
It is recommended to read through the entire installation procedure AND the troubleshooting part before actually starting the installation.

Installation of dependencies

Install git, python3 and make: make sure that git, python3 and make are installed. If they are not installed, install them via
```
sudo apt install git make python3
```
Install CMake: install cmake from the Ubuntu software centre (snap package). The installation was successfully tested with version 3.21.4 of cmake. Create an alias in the .bashrc for cmake:
```
alias cmake='/snap/cmake/current/bin/cmake'
```
Install conan: to install vmm-sdat conan, a C++ package manager, is needed. Conan itself requires Python. However, with Python2.X the installation works not correctly. Thus, remove the Python2 packages from your system via
```
sudo apt remove python2*
```
Add then the following alias to your .bashrc:
```
alias python='python3'
alias pip='pip3'
```
Then install conan via
```
pip3 install -v "conan==1.59.0"
```
Install Qt: if you do not have Qt on your system, download it from the Qt pages. The installer for Qt version 5.12.9 weights about 1.3GB. The full installation procedure of Qt takes less than 1 hour on a machine with adequate internet connection. Once downloaded, make sure the file is executable:
```
chmod +x qt-opensource-linux-x64-5.12.9.run
```
Now, install. The installation folder should be "/home/username/Qt5.12.9/". For this case, username is "daq", so the installation folder is "/home/daq/Qt5.12.9/".
```
sudo ./qt-opensource-linux-x64-5.12.9.run
```
Follow the installer prompts. Make sure to select installation of all components options. Once the installer is finished, it is highly recommended to remove administrator rights for the Qt directory and all subdirectories, so the sudo command does not need to be applied every time Slow Control is run.
```
sudo chmod -R 777 /home/daq/Qt5.12.9/
```
To check that the installation has been successful:
```
qmake --version
```

Install OpenGL: install OpenGL via

sudo apt-get install libglu1-mesa-dev freeglut3-dev mesa-common-dev

Install gcc-9: please make sure that at least gcc/g++ version 9 is installed. Just type

gcc --version

If it is version 9 or higher, just skip the next instructions and jump to point 2. Otherwise, ddd the Ubuntu Toolchain test repository list:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt update
sudo apt install gcc-9
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 9
sudo apt install g++-9
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-9 9

Installation of components

Wireshark: an essential tool for operating VMM3a/SRS, which should be installed before the Slow Control is Wireshark. Please install Wireshark with Lua support. To install Wireshark type
```
sudo apt install wireshark-qt
```
In this repository, a lua script is provided that turns HEX-values of the UDP packages from the FEC, displays the hits from the VMMs and makes the information human readable. It might be convenient to create an alias in `.bashrc to start Wireshark with the corresponding Lua script:
```
alias essws='wireshark -X lua_script:/path_to_slow_control/vmmsc/vmm3a_srs.lua'
```
Please add Wireshark to the sudoers group via
```
sudo adduser $USER wireshark
```

Perform the git clone commands of the software

git clone https://gitlab.cern.ch/rd51-slow-control/vmmsc
git clone https://github.com/ess-dmsc/vmm-sdat

Slow Control: Some modifications have to be added to the .bashrc:
```
export PATH="/home/daq/Qt5.12.9/5.12.9/gcc_64/bin/:$PATH"
export CXX="/usr/bin/g++-9"
```
Make sure to reload the bashrc via
```
source .bashrc
```
Now navigate to the new directory (assuming that the starting point is the home directory):
```
cd vmmsc/build
```
Run qmake. Make sure you use the correct qmake in case you have several Qt versions installed:
```
qmake vmmdcs.pro
```
The next step is to compile the package:
```
make clean
make -j10
```
The executable will now be located in the path vmmsc/build To open Slow Control on linux use the following command:
```
./vmmdcs
```
On macOS use this command:
```
./vmmdcs.app/Contents/MacOS/vmmdcs
```
The vmmdcs.pro file is set up to point to the include paths/dependencies based on whether the operating system is linux or macOS (mac being the only other considered system other than linux). Just as a reminder: if you run into problems during the installation, please check the troubleshooting page.
If not already done before, install ROOT. See https://root.cern/install/ on how to install it. Do not forget to install the ROOT prequesites (already adjusted for vmm-sdat):
```
sudo apt-get install dpkg-dev binutils libx11-dev libxpm-dev libxft-dev libxext-dev libssl-dev
```
Install vmm-sdat: Just go in the corresponding directory, create the build-directory and just execute cmake .. and make, as described here.

Configuration procedure

Network port

The network port, where you are connecting the SRS to, should have the IP address 10.0.0.3 with a netmask of 255.255.255.0 and an MTU of 9000. Please ensure that you have the things set like this. It is one of the most common mistakes!