Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve notebooks #11

Closed
3 tasks done
rmsare opened this issue Jun 14, 2019 · 1 comment
Closed
3 tasks done

Improve notebooks #11

rmsare opened this issue Jun 14, 2019 · 1 comment

Comments

@rmsare
Copy link

rmsare commented Jun 14, 2019

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

(JOSS review thread)

@rmsare
Copy link
Author

rmsare commented Jul 4, 2019

The default example is now ready to run, and the notebooks have been improved

@rmsare rmsare closed this as completed Jul 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant