You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The notebooks run smoothly, thank you for providing them. Here are some small changes that could make them much more user-friendly.
Each notebook should have a title and one sentence explaining what it does. Ideally some inline Markdown cells should tell the user what to change and what's going on.
Instead of a single script pasted in the first cell, I suggest you separate the cells logically so the user can step through the analysis. This might be: one cell for imports, one cell for user-defined variables not specified in a widget, one cell per widget definition, and a final "run" cell. Or, if you don't want to use cells, please add header comments as you did in CSV_Creator.ipynb.
See examples of clean notebooks and example scripts here and here.
Finally, please populate the widget fields in CometTS_Visualizer.ipynb with relative paths to your San Juan example. This will allow the user to immediately see what CometTS can do.
Add headers and explanatory text to notebooks
Separate cells or add header comments for clarity
Populate default example in CometTS_Visualizer.ipynb
The notebooks run smoothly, thank you for providing them. Here are some small changes that could make them much more user-friendly.
Each notebook should have a title and one sentence explaining what it does. Ideally some inline Markdown cells should tell the user what to change and what's going on.
Instead of a single script pasted in the first cell, I suggest you separate the cells logically so the user can step through the analysis. This might be: one cell for imports, one cell for user-defined variables not specified in a widget, one cell per widget definition, and a final "run" cell. Or, if you don't want to use cells, please add header comments as you did in
CSV_Creator.ipynb
.See examples of clean notebooks and example scripts here and here.
Finally, please populate the widget fields in
CometTS_Visualizer.ipynb
with relative paths to your San Juan example. This will allow the user to immediately see what CometTS can do.CometTS_Visualizer.ipynb
(JOSS review thread)
The text was updated successfully, but these errors were encountered: