1 of 2

Building squirrel library and utils

Overview

The following OS configurations have been tested to build squirrel with Qt 6.5

Compatible
- RHEL compatible Linux 8 (not 8.6)
- CentOS 8 (not CentOS 8 Stream)
- CentOS 7
- Windows 10/11

squirrel library and utils cannot be built on CentOS Stream 8 or Rocky Linux 8.6. There are kernel bugs which do not work correctly with Qt's QProcess library. This can lead to inconsistencies when running shell commands, and qmake build errors.

Other OS configurations may work to build squirrel, but have not been tested.

Prepare Build Environment

Install the following as root

dnf group install 'Development Tools'
dnf install cmake3
dnf install xcb*
dnf install libxcb*

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

yum group install 'Development Tools'
yum install cmake3
yum install xcb*
yum install libxcb*
yum install gcc-toolset-10

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

yum install epel-release
yum group install 'Development Tools'
yum install cmake3

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

apt install build-essential
apt install libxcb*
apt install make
apt install cmake

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install build environment

Install Visual Studio 2019 Community edition, available from Microsoft. Install the C++ extensions.
Install CMake3
Install Qt 6.4.2 for MSVC2019 x64
Install Github Desktop, or TortoiseGit, or other Git interface

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Run the setup program.
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → MSVC 2019 64-bit

Building the squirrel Library

Once the build environment is setup, the build process can be performed by script. The build.sh script will build the squirrel library files and the squirrel utils.

The first time building squirrel on this machine, perform the following

cd ~
wget https://github.com/gbook/squirrel/archive/main.zip
unzip main.zip
mv squirrel-main squirrel
cd squirrel
./build.sh

This will build gdcm (squirrel depends on GDCM for reading DICOM headers), squirrel lib, and squirrel-gui.

All subsequent builds on this machine can be done with the following

cd ~/squirrel
./build.sh

Using Github Desktop, clone the squirrel repository to C:\squirrel
Build GDCM
- Open CMake
- Set source directory to C:\squirrel\src\gdcm
- Set build directory to C:\squirrel\bin\gdcm
- Click Configure (click Yes to create the build directory)
- Select Visual Studio 16 2019. Click Finish
- After it's done generating, make sure GDCM_BUILD_SHARED_LIBS is checked
- Click Configure again
- Click Generate. This will create the Visual Studio solution and project files
- Open the C:\squirrel\bin\gdcm\GDCM.sln file in Visual Studio
- Change the build to Release
- Right-click ALL_BUILD and click Build
Build squirrel library
- Double-click C:\squirrel\src\squirrel\squirrellib.pro
- Configure the project for Qt 6.4.2 as necessary
- Switch the build to Release and build it
- squirrel.dll and squirrel.lib will now be in C:\squirrel\bin\squirrel
Build squirrel-gui
- Configure the project for Qt 6.4.2 as necessary
- Double-click C:\squirrel\src\squirrel-gui\squirrel-gui.pro
- Switch the build to Release and build it

Contributing to the squirrel Library

Setting up a development environment

Once you've been granted access to the squirrel project on github, you'll need to add your server's SSH key to your github account (github.com --> click your username --> Settings --> SSH and GPG keys). There are directions on the github site for how to do this. Then you can clone the current source code into your server.

Cloning a new repository with SSH

cd ~
git clone git@github.com:gbook/squirrel.git squirrel

This will create a git repository called squirrel in your home directory.

Committing changes

cd ~/squirrel
git commit -am "Comments about the changes"
git push origin main

Updating your repository

To keep your local copy of the repository up to date, you'll need to pull any changes from github.

cd ~/squirrel
git pull origin main

Troubleshooting

Build freezes

This may happen if the build machine does not have enough RAM or processors. More likely this is happening inside of a VM in which the VM does not have enough RAM or processors allocated.

Build fails with "QMAKE_CXX.COMPILER_MACROS not defined"

This error happens because of a kernel bug in RHEL 8.6. Downgrade to 8.5 or upgrade to 8.7.

Library error

This example is from the nidb example. If you get an error similar to the following, you'll need to install the missing library

./nidb: error while loading shared libraries: libsquirrel.so.1: cannot open shared object file: No such file or directory./nidb: error while loading shared libraries: libsquirrel.so.1: cannot open shared object file: No such file or directory

You can check which libraries are missing by running ldd on the nidb executable

[nidb@ado2dev bin]$ ldd nidb
        linux-vdso.so.1 (0x00007ffd07fe4000)
        libSMTPEmail.so.1 => /lib/libSMTPEmail.so.1 (0x00007fdb4e2b0000)
        libsquirrel.so.1 => not found
        libgdcmMSFF.so.3.0 => /lib/libgdcmMSFF.so.3.0 (0x00007fdb4dd88000)
        libgdcmCommon.so.3.0 => /lib/libgdcmCommon.so.3.0 (0x00007fdb4db60000)
        libgdcmDICT.so.3.0 => /lib/libgdcmDICT.so.3.0 (0x00007fdb4d688000)
        libgdcmDSED.so.3.0 => /lib/libgdcmDSED.so.3.0 (0x00007fdb4d348000)

Copy the missing library file(s) to /lib as root. Then run ldconfig to register any new libraries.

Virtual Machine Has No Network

If you are using a virtual machine to build, there are a couple of weird bugs in VMWare Workstation Player (possibly other VMWare products as well) where the network adapters on a Linux guest simply stop working. You can't activate them, you can't do anything with them, they just are offline and can't be activated. Or it's connected and network connection is present, but your VM is inaccessible from the outside.

Try these fixes to get the network back:

While the VM is running, suspend the guest OS. Wait for it to suspend and close itself. Then resume the guest OS. No idea why, but this should fix the lack of network adapter in Linux.
Open the VM settings. Go to network, and click the button to edit the bridged adapters. Uncheck the VM adapter. This is if you are using bridged networking only.
Switch to NAT networking. This may be better if you are connected to a public wifi.

Using the squirrel Library

Copy the squirrel library files to the lib directory. The libs will then be available for the whole system.

cd ~/squirrel/bin/squirrel
sudo cp -uv libsquirrel* /lib/

Building Python Wrapper

How to build a Python wrapper for the squirrel library

Prerequisites

On RHEL8 Linux

Create the wrapper

Building squirrel library and utils

Overview

The following OS configurations have been tested to build squirrel with Qt 6.5

Compatible
- RHEL compatible Linux 8 (not 8.6)
- CentOS 8 (not CentOS 8 Stream)
- CentOS 7
- Windows 10/11

Other OS configurations may work to build squirrel, but have not been tested.

Prepare Build Environment

Install the following as root

dnf group install 'Development Tools'
dnf install cmake3
dnf install xcb*
dnf install libxcb*

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

yum group install 'Development Tools'
yum install cmake3
yum install xcb*
yum install libxcb*
yum install gcc-toolset-10

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

yum install epel-release
yum group install 'Development Tools'
yum install cmake3

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install the following as root

apt install build-essential
apt install libxcb*
apt install make
apt install cmake

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Make the installer executable chmod 777 qt-unified-linux-x64-x.x.x-online.run
Run ./qt-unified-linux-x64-x.x.x-online.run
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → Desktop gcc 64-bit

Install build environment

Install Visual Studio 2019 Community edition, available from Microsoft. Install the C++ extensions.
Install CMake3
Install Qt 6.4.2 for MSVC2019 x64
Install Github Desktop, or TortoiseGit, or other Git interface

Install Qt

Download Qt open-source from https://www.qt.io/download-open-source
Run the setup program.
The Qt Maintenance Tool will start. An account is required to download Qt open source.
On the components screen, select the checkbox for Qt 6.5.3 → MSVC 2019 64-bit

Building the squirrel Library

Once the build environment is setup, the build process can be performed by script. The build.sh script will build the squirrel library files and the squirrel utils.

The first time building squirrel on this machine, perform the following

cd ~
wget https://github.com/gbook/squirrel/archive/main.zip
unzip main.zip
mv squirrel-main squirrel
cd squirrel
./build.sh

This will build gdcm (squirrel depends on GDCM for reading DICOM headers), squirrel lib, and squirrel-gui.

All subsequent builds on this machine can be done with the following

cd ~/squirrel
./build.sh

Using Github Desktop, clone the squirrel repository to C:\squirrel
Build GDCM
- Open CMake
- Set source directory to C:\squirrel\src\gdcm
- Set build directory to C:\squirrel\bin\gdcm
- Click Configure (click Yes to create the build directory)
- Select Visual Studio 16 2019. Click Finish
- After it's done generating, make sure GDCM_BUILD_SHARED_LIBS is checked
- Click Configure again
- Click Generate. This will create the Visual Studio solution and project files
- Open the C:\squirrel\bin\gdcm\GDCM.sln file in Visual Studio
- Change the build to Release
- Right-click ALL_BUILD and click Build
Build squirrel library
- Double-click C:\squirrel\src\squirrel\squirrellib.pro
- Configure the project for Qt 6.4.2 as necessary
- Switch the build to Release and build it
- squirrel.dll and squirrel.lib will now be in C:\squirrel\bin\squirrel
Build squirrel-gui
- Configure the project for Qt 6.4.2 as necessary
- Double-click C:\squirrel\src\squirrel-gui\squirrel-gui.pro
- Switch the build to Release and build it

Contributing to the squirrel Library

Setting up a development environment

Cloning a new repository with SSH

cd ~
git clone git@github.com:gbook/squirrel.git squirrel

This will create a git repository called squirrel in your home directory.

Committing changes

cd ~/squirrel
git commit -am "Comments about the changes"
git push origin main

Updating your repository

To keep your local copy of the repository up to date, you'll need to pull any changes from github.

cd ~/squirrel
git pull origin main

Troubleshooting

Build freezes

This may happen if the build machine does not have enough RAM or processors. More likely this is happening inside of a VM in which the VM does not have enough RAM or processors allocated.

Build fails with "QMAKE_CXX.COMPILER_MACROS not defined"

This error happens because of a kernel bug in RHEL 8.6. Downgrade to 8.5 or upgrade to 8.7.

Library error

This example is from the nidb example. If you get an error similar to the following, you'll need to install the missing library

./nidb: error while loading shared libraries: libsquirrel.so.1: cannot open shared object file: No such file or directory./nidb: error while loading shared libraries: libsquirrel.so.1: cannot open shared object file: No such file or directory

You can check which libraries are missing by running ldd on the nidb executable

[nidb@ado2dev bin]$ ldd nidb
        linux-vdso.so.1 (0x00007ffd07fe4000)
        libSMTPEmail.so.1 => /lib/libSMTPEmail.so.1 (0x00007fdb4e2b0000)
        libsquirrel.so.1 => not found
        libgdcmMSFF.so.3.0 => /lib/libgdcmMSFF.so.3.0 (0x00007fdb4dd88000)
        libgdcmCommon.so.3.0 => /lib/libgdcmCommon.so.3.0 (0x00007fdb4db60000)
        libgdcmDICT.so.3.0 => /lib/libgdcmDICT.so.3.0 (0x00007fdb4d688000)
        libgdcmDSED.so.3.0 => /lib/libgdcmDSED.so.3.0 (0x00007fdb4d348000)

Copy the missing library file(s) to /lib as root. Then run ldconfig to register any new libraries.

Virtual Machine Has No Network

Try these fixes to get the network back:

While the VM is running, suspend the guest OS. Wait for it to suspend and close itself. Then resume the guest OS. No idea why, but this should fix the lack of network adapter in Linux.
Open the VM settings. Go to network, and click the button to edit the bridged adapters. Uncheck the VM adapter. This is if you are using bridged networking only.
Switch to NAT networking. This may be better if you are connected to a public wifi.

Using the squirrel Library

Copy the squirrel library files to the lib directory. The libs will then be available for the whole system.

cd ~/squirrel/bin/squirrel
sudo cp -uv libsquirrel* /lib/