Battery-Intelligence-Lab / dtw-cpp

DTWC++
https://battery-intelligence-lab.github.io/dtw-cpp/
Other
6 stars 2 forks source link

Minor comments in executive file location #12

Closed ZhenchenHong closed 4 weeks ago

ZhenchenHong commented 2 months ago

Hi authors, I am reviewing the code from https://github.com/openjournals/joss-reviews/issues/6881#issue-2349216956. Could you please add the directory of dtwc_main to help the user to specify the location? To be specifically, in https://battery-intelligence-lab.github.io/dtw-cpp/1_getting_started/direct_use.html, you may add the ./dtw-cpp/bin to direct people to the correct path. Thanks!

ElektrikAkar commented 2 months ago

Hi, thank you very much for your comment, I have added the folder in the instructions in commit 4e3b51ef5b6bce9ccbc6690cb755bfbb0350d548. Please let me know if any further clarification is needed.

i64 commented 2 months ago

I agree with @ZhenchenHong. I think the authors can also fix location confusion in the "running" section.

ElektrikAkar commented 4 weeks ago

Hi,

Thank you very much for both your comment! You are right that there was a lot of confusion in the installation section. Now, we have fully updated the installation documentation https://github.com/Battery-Intelligence-Lab/dtw-cpp/pull/20

Hopefully now it looks much better: https://battery-intelligence-lab.github.io/dtw-cpp/1_getting_started/1_installation.html

Please let us know if there are any further changes we can make to improve the quality of the documentation.

i64 commented 4 weeks ago

Hi @ElektrikAkar,

I checked the commit. LGTM!

ElektrikAkar commented 4 weeks ago

Hi, as both reviewers are happy with the current state, I am closing the issue. Many thanks for your efforts.