Format tutorial notebook for user-friendliness

[bnord]

• [x] Consider following Rubin observatory standards
• [x] Search for other standards that might meed our needs.
• [x] Consider making it fun-ish, because students might use this.

[bnord]

• https://towardsdatascience.com/jupyter-notebook-best-practices-f430a6ba8c69
• https://towardsdatascience.com/best-practices-for-writing-reproducible-and-maintainable-jupyter-notebooks-49fcc984ea68
• https://levelup.gitconnected.com/jupyter-notebook-best-practices-fc326eb5cd22

[samueldmcdermott]

those latter ones are behind paywalls for me, but I'll try to mimic the style of the first one (from Rubin)

[samueldmcdermott]

assigning this to @bnord to check for user friendliness

[bnord]

@samueldmcdermott Which guide did you use?

[samueldmcdermott]

the links in the comment were paywalled for me, so I mimicked the style of https://github.com/rubin-dp0/cst-dev/blob/main/MLG_sandbox/DP02/citsci_sample_demo.ipynb -- mostly just putting in headings and divisions

[bnord]

@samueldmcdermott could you link here the file(s) I should look at?

[samueldmcdermott]

https://github.com/deepskies/simcmb/blob/main/notebooks/simcmb_example.ipynb

[cavestruz]

Sam did first check on checklist already in PR for #67. Checklist items 2 and 3 should only be in response to user feedback. Otherwise, difficult to scope out actual to-do's.
Closes with Issue #67

[bnord]

Yo0: an instance of simcmb.Yobj that holds a CAMBparams instance and other metadata necessary to complete runs (noise, dictionaries of iterables that we might want to eventually cycle over, etc.)

PM0: an instance of simcmb.PS_Maker that stores results from CAMB runs and their associated parameter values

I think these variables (and others in the doc) should be more informative/expressive/human-readable.

I agree with the advice in this video: https://www.youtube.com/watch?v=-J3wNP6u5YU

[samueldmcdermott]

I'm happy to rename them anything you like! Alternately, feel free to rename them and push the notebook yourself

[cavestruz]

As a heads up - the action item of "switch variable names for readability" is a solid clear goal. This merits a new issue with that title, and a new linked branch to that issue. And there, we can have a checklist of things being switched, or groups of things being switched. And, the link to the YouTube video as a reference for guidance.

This re-opened issue is too broad.

On Fri, May 26, 2023, 13:08 samueldmcdermott @.***> wrote:

I'm happy to rename them anything you like! Alternately, feel free to rename them and push the notebook yourself

— Reply to this email directly, view it on GitHub https://github.com/deepskies/simcmb/issues/63#issuecomment-1564684110, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABEVG64QLUTVNOP7NTOLPNTXIDPQ5ANCNFSM6AAAAAAX5G72P4 . You are receiving this because you modified the open/close state.Message ID: @.***>

[samueldmcdermott]

putting requests for changes to names in notebook into #69