UtrechtUniversity / workshop-computational-reproducibility

Material for the workshop 'Best Practices for Writing Reproducible Code'
https://utrechtuniversity.github.io/workshop-computational-reproducibility/
Other
9 stars 13 forks source link

reproducibility in matlab #34

Open nehamoopen opened 1 year ago

nehamoopen commented 1 year ago

Some MATLAB stuff that a participant (thanks, Gerrit Muller!) found during the course, may be helpful for future course participants:

Style guide: https://de.mathworks.com/matlabcentral/fileexchange/46056-matlab-style-guidelines-2-0

Call Matlab from python: https://de.mathworks.com/help/matlab/matlab-engine-for-python.html?s_tid=CRUX_lftnav

Notebooks in matlab: https://de.mathworks.com/matlabcentral/answers/53454-matlab-equivalent-to-ipython-notebook

https://anneurai.net/2015/11/12/matlab-based-ipython-notebooks/

Profiler (to spot most time-intensive function): https://de.mathworks.com/help/matlab/ref/profile.html

and the linter: https://de.mathworks.com/help/matlab/ref/mlint.html

andrejsho commented 1 year ago

Addition to documentation, comments and docstrings:

Add comments to your code: https://nl.mathworks.com/help/matlab/matlab_prog/comments.html

Add help to your program: https://nl.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html

"Create help summary files": https://nl.mathworks.com/help/matlab/matlab_prog/create-a-help-summary-contents-m.html

According dependencies:

https://nl.mathworks.com/help/matlab/matlab_prog/identify-dependencies.html

General

Guide about a lot of things concerning structuring in Matlab (official Matlab help pages are also referring there) https://nl.mathworks.com/matlabcentral/fileexchange/115905-programming-structuring-code