matnwb
matnwb copied to clipboard
[Feature]: MATLAB Live launch buttons for tutorials
What would you like to see added to MatNWB?
see title
Is your feature request related to a problem?
No response
What solution would you like?
see title
Do you have any interest in helping implement the feature?
Yes.
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
- [X] Have you ensured this change was not already requested?
Do you mean something like https://www.mathworks.com/help/matlab/matlab_prog/add-interactive-controls-to-a-live-script.html
No, I mean a button in the README to launch a free MATLAB cloud instance with that tutorial livescript file loaded and ready to run. I'm not sure if this is possible but worth a try
@bendichter If it helps, I'd be glad to give a demo of other toolboxes using Open in MATLAB Online for tutorial examples as you describe. So long as the data size is manageable, whether as part of repo or accessed via S3, I believe this should work well for MatNWB.
@vijayiyer05 that would be great. In fact, there is no source data so this should be quite simple to set up.
Example here: https://github.com/NeurodataWithoutBorders/matnwb/tree/546-add-live-launch-buttons
Added a "Open in MATLAB Online" badge in the beginning of the readme as well as two "run in matlab online" links on the tutorial list.
@ehennestad this is great!
Would you mind going through our standard workflow for changes? That would be:
- File an issue (this was done already)
- Create a new branch that addresses the issue (as you have done)
- Create a PR that merges into master
- In the description of the PR, write
"fix #546"
. This is a keyword for GitHub to automatically link the PR to that Issue. When the PR is merged, the Issue will be automatically closed. Only right"fix #[num]"
if you think the merging of this PR truly concludes the issue. If you want to link it but not close it, you can write something like"related to #546"
. This will create a bi-directional link without the automatic closing feature. - Assign another developer (e.g. me) as a reviewer. I am a good person to choose esp. for issues I raise or for documentation-related issues like this.
I know this can kind of be a bit onerous, especially for smaller PRs like this, but it helps us manage many PRs as a team across a lot of repos.