Third-party software installation guidelines

i64 commented 1 month ago

Hi authors, I am reviewing the code from openjournals/joss-reviews#6881.

The third-party software (e.g., CMake, OpenMP, Gurobi) installation guidelines are missing and could be integrated into the documentation.

i64 commented 1 month ago

Another thing is, in the Linux section, it should be made clear which linux distribution it is. Then for example the installation comments could be such as

sudo apt install build-essential
sudo apt install cmake libomp-dev

ElektrikAkar commented 1 week ago

Hi,

Thank you very much for your comment! We have fully updated the installation documentation https://github.com/Battery-Intelligence-Lab/dtw-cpp/pull/20.

We integrated CMake installation into the bash commands.
OpenMP is mostly included in GCC and MSVC installations; however, we included the necessary command for Apple Clang and added a note on installing the required OpenMP version for Ubuntu.
For Gurobi, we linked to the visual guidelines provided by the company. However, since it is a somewhat lengthy process and an optional dependency, we chose not to copy and paste all the steps.
Lastly, we integrated CPMLicenses.cmake to print the licenses of some dependencies included in the binary executable.

Please let us know if any further clarification on the third-party software is needed.

i64 commented 1 week ago

Hi @ElektrikAkar,

I checked the commit. LGTM!

Battery-Intelligence-Lab / dtw-cpp

Third-party software installation guidelines #16