Installation method of parallelproj not clear in documentation

[robbietuk]

Currently the only comments are in the release notes here (not in the users guide):

STIR/documentation/release_5.0.htm

Lines 75 to 80 in 4b36d66

	<li><a href=https://github.com/gschramm/parallelproj>Georg's Schramm parallelproj</a> is an
	implementation of the Joseph algorithm for projection. If it has been installed
	in your system, and you tell CMake where to find it (`parallelproj_DIR=/wherever/lib/cmake`), the STIR user is
	now able to select an additional projector, called <code>Parallelproj</code>. This will use the CUDA
	version if available, otherwise will fall-back to the OpenMP version. Check the new sample files in
	<tt>examples/samples</tt> and the section in the User's Guide.</li>

I have installed parallelproj using the method detailed here, by calling:

python build_libs_for_python.py

I set parallelproj_DIR=/wherever/lib_Linux_64bit/cmake (it seems it creates lib_Linux_64bit instead of lib) and add it to my $PATH. The cmake configuration reports:

 Found parallelproj (will use its CUDA support)
 Parallelproj projector support enabled.

STIR installs as normal but then I get the following errors when calling many STIR executables.

[******@login13 build]$ forward_project 
forward_project: error while loading shared libraries: libparallelproj_c.so: cannot open shared object file: No such file or directory

[KrisThielemans]

I don't think this is a STIR issue really. Please file at https://github.com/gschramm/parallelproj. Run-time path needs to be set LD_LIBRARY_PATH on Linux, something else on MacOS, PATH on Windows.

lib_Linux_64bit is surprising. I guess we were expecting lib64. Email conversation on that (sadly not on github).

[KrisThielemans]

iOnce paralleproj doc is fixed, we could point to it on our installation guide, but do we do this for all dependencies? (e.g. ROOT). It would become unwieldly....

Note that the SIRF-Superbuild will try to take care of this (but currently won't handle lib_Linux_64bit)

[robbietuk]

I will file an issue there.

This issue is still needed for STIR as we should have some instructions as to what STIR needs, e.g. have parallelproj in PATH and LD_LIBRARY_PATHetc.

Once paralleproj doc is fixed, we could point to it on our installation guide, but do we do this for all dependencies? (e.g. ROOT). It would become unwieldly....

I agree, but some infomation might be useful. I.e. how to make cmake find it:

STIR/documentation/STIR-UsersGuide.tex

Line 4408 in 4b36d66

This projector is only available if STIR has been built with parallelproj support (by letting CMake finding it).

[KrisThielemans]

as we should have some instructions as to what STIR needs

I really don't want to repeat specific instructions on installation for any of the dependencies in the STIR User's Guide. It's a recipe for being-out-of-date-very-quickly. Providing pointers, yes, of course.

Contributions welcome of course (but you knew that 😄 )

Some stuff could also fit more in the STIR wiki (although that's problematically slow right now)

[robbietuk]

Closing because cmake mistake, see gschramm/parallelproj#9