missing information and folder
sandany opened this issue · 0 comments
sandany commented
Hello, thank you for sharing this great repository. Please allow me to share a few comments that I believe would facilitate access to this repository.
- To elaborate more in detail on an issue that was previously reported, but still not addressed, the MATLAB script simulation.m gives an error when trying to execute “simulate()” on line 17. This is because MATLAB is trying to write in a non-existent folder “figures”. It appears that MATLAB cannot create the non-existing folder while running the script. I tried to run MATLAB in administrator mode, uncheck “read-only” on the folders, and copy the folder to the Desktop, non of these solved the permission issue. As previously noted, the user has to manually create the missing folder “figures” in “sliding-ds-control-main\scripts\” for it to work. I suggest including the empty folder in the repository. I can confirm otherwise that the code runs great.
- The Data folder is missing from the main repository, although it says on the readme file that it should be there. After searching, I noticed that there is actually more than one repository for this project, it would therefore be nice to have a more detailed repository structure explanation so that the user is made aware of where all the available files can be found.
-
The MATLAB scripts appear to be insufficiently documented, particularly concerning the headers. Only the main script simulation.m has a header, but even then, only basic author and data information is provided, not a detailed explanation of what the main script does. Also, only this script is well documented in the code. All the other scripts have no header at all and no comments in the code, making it very difficult to follow. I would recommend including the necessary header in all the scripts, including a description of what each function actually does.
For information, I am running MATLAB 2022a on Windows 10, with python 3.10.