[JOSS] Compiling documentation

[EmilyBourne]

This issue relates to ongoing reviews at openjournals/joss-reviews#7018.

The documentation at https://discotec.readthedocs.io/ doesn't seem to include any information about how to compile.

In https://discotec.readthedocs.io/en/latest/simple_tutorial.html you say:

Compile the code using your familiar build tools. MPI and DisCoTec should be the only immediate dependencies.

But this doesn't explain how to make DisCoTec into a dependency.

For a compilation with Makefile I imagine that we need to include the src/ folder and build-linux-ubuntu22.04-skylake-ak5g3b5/spack-build-ak5g3b5/src/libdiscotec.a. Is this everything that is needed?

For a compilation with CMake, I am not sure how to proceed. Is there a way to link the package e.g. find_package(DisCoTec)? Or should I use add_subdirectory(DisCoTec)? Or something else

[freifrauvonbleifrei]

excellent question! for the examples as a standalone target, we use add_subdirectory (cf.

DisCoTec/examples/distributed_third_level/CMakeLists.txt

Line 15 in 9b5f190

add_subdirectory(../../src discotec)

), but I suppose you are looking for an install step for DisCoTec? Let me think about how to do this!

[freifrauvonbleifrei]

Ah, as per your other question @EmilyBourne : yes, only libdiscotec.a and the headers (and dependencies etc.) should be required.

[freifrauvonbleifrei]

I just realized that @vancraar has already put a neat installation step here:

DisCoTec/src/CMakeLists.txt

Line 248 in 9b5f190

install(TARGETS discotec

however, it is currently not installing the header files, only the library and all other executables.

So you can either go ahead with add_subdirectory(DisCoTec/src) or give us a few days to make find_package work @EmilyBourne

[EmilyBourne]

I have already gone ahead and used add_subdirectory(DisCoTec/src) for testing. But I think this issue should be resolved in order to accept the paper in any case (either by documenting the use of add_subdirectory(DisCoTec/src) or by getting find_package to work).

If you want to go the find_package route, you may find this useful:
https://cmake.org/cmake/help/latest/module/CMakePackageConfigHelpers.html

[freifrauvonbleifrei]

@EmilyBourne I have added the add_subdirectory instruction for now, the proper find_package setup is quite fiddly (esp. to get the paths nice and expressive). Will include the find_package instructions with #145, but we can leave that out of the review for now. Let me know what you think!