2541 nightly build artifact doesnt start on mac

[wpotrzebowski]

Description

Fixing OSX build from the main branch. It is pyside2 that is problematic and therefore it was removed from requirements (keeping only PySide6).
It also updates the version of Python and the installer. These were probably not required, but it will be a useful update if it works on all platforms.

Fixes # (issue/issues)
#2541

How Has This Been Tested?

Installer downloaded and tested.

Review Checklist (please remove items if they don't apply):

• Code has been reviewed
• Functionality has been tested
• Windows installer (GH artifact) has been tested (installed and worked)
• MacOSX installer (GH artifact) has been tested (installed and worked)
• The introduced changes comply with SasView license (BSD 3-Clause)

[wpotrzebowski]

@rozyczko if you can please check if Windows installer works that would be great.

[rozyczko]

This build seems to run OK on Windows (quick, cursory test).
However, I would be careful with piling in two unrelated changes into this bugfix.
The bugfix itself consists of removal of pyside2 from requirements.txt and replacing pyside2 with pyside6 in pytest.ini. Also, adding the missing GL linux library.

But, unlocking the pyinstaller version and especially bumping Python from 3.8 to 3.9 should be probably done in separate, appropriately named branches and tested well first, I think.

[wpotrzebowski]

@rozyczko good suggestion! I've modified this PR, so it only addresses the original issue. Can you take a quick look at the installer again (after the latest changes)?

It would be also good if someone also tests ubuntu installer. @ehewins will you be able to do it?

[rozyczko]

Yes, this works on Windows.

[ehewins]

I can confirm that building and running SasView from this PR works perfectly on Linux/Ubuntu, but there is a problem with the .tar.gz archive packaged in the nightly-build release.
It's conventional to include an "INSTALL" or a "README" file with instructions on how to install the package (or a script to automate the process), but the archive only contains the sasview binary itself and all the dependencies. The sasview binary won't run unless the dependencies are installed properly somewhere, and at the moment the user has to work out for themselves how to do this in a way which doesn't cause any conflicts with their other programs.

[llimeht]

It's conventional to include an "INSTALL" or a "README" file with instructions on how to install the package (or a script to automate the process), but the archive only contains the sasview binary itself and all the dependencies. The sasview binary won't run unless the dependencies are installed properly somewhere, and at the moment the user has to work out for themselves how to do this in a way which doesn't cause any conflicts with their other programs.

Some sort of README would be good to explain what happens next in all of the downloads. For the Ubuntu tarball, there's not actually anything that is required — in particular, the user does not have to figure out how to install it or deal with conflicts between these packages and system packages. There's a chance some extra X-related system packages need to be installed, as is done in the rather cursory CI test of the installer.

As a starting point, this is what is needed:

$ tar xf sasview5.tar.gz
$ ./sasview/sasview

Running it with an absolute path from any location also works:

$ mkdir ~/software
$ tar x -C ~/software -f sasview5.tar.gz 
$ /home/stuart/software/sasview/sasview

[wpotrzebowski]

@ehewins thanks for testing. I will merge it now as it is critical for Mac users. It would be good to get documentation for ubuntu in place.

[ehewins]

Some sort of README would be good to explain what happens next in all of the downloads. For the Ubuntu tarball, there's not actually anything that is required — in particular, the user does not have to figure out how to install it or deal with conflicts between these packages and system packages. There's a chance some extra X-related system packages need to be installed, as is done in the rather cursory CI test of the installer.

As a starting point, this is what is needed:

$ tar xf sasview5.tar.gz
$ ./sasview/sasview

Running it with an absolute path from any location also works:

$ mkdir ~/software
$ tar x -C ~/software -f sasview5.tar.gz 
$ /home/stuart/software/sasview/sasview

Thanks for clarifying @llimeht . The sasview binary returns several "Failed to load module" errors when I run it in an Ubuntu VM, but the process goes off without a hitch when I try running it on my main Arch system. Perhaps it's an issue specific to my VM setup.

[llimeht]

Thanks for clarifying @llimeht . The sasview binary returns several "Failed to load module" errors when I run it in an Ubuntu VM, but the process goes off without a hitch when I try running it on my main Arch system. Perhaps it's an issue specific to my VM setup.

It might be that some additional X-related libraries need to be installed for Qt to work, given recent Ubuntu defaults to Wayland (I think).

CI does the following to run the package:

 sudo apt install libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils xvfb

xvfb would not be necessary; there's also a chance that some of the others aren't needed either, but won't do any harm.

Steps like that aren't needed on older Debian/Ubuntu machines as those were packages that would already be installed… but if these are now required, then we should definitely document this in a README as you suggest!