Verify main citsci notebook meets RTN045 requirements

lsst-epo / citizen-science-notebooks

A collection Jupyter notebooks that can be used to associate Rubin Science Platform data to a Zooniverse citizen science project.

3 stars 1 forks source link

Verify main citsci notebook meets RTN045 requirements #86

Closed beckynevin closed 6 months ago

beckynevin commented 6 months ago

Hi all, I'm making this a PR to get some feedback on whether the current notebook meets RTN045 requirements. I did my best to go through and make changes after the accessibility notebook workshop. I'd love to get your 2cents on what we can further improve.

https://rtn-045.lsst.io/

beckynevin commented 6 months ago

Hi @MelissaGraham , thanks for the comments! So far I've made some changes:

[x] Remove the code cell for style check
[x] make a note that rubin.citsci will be installed on RSP
[x] removing comments from code cells, use # only for commented out code
[x] use the imperative voice (remove you/we statements)
[x] fixed the strange raw cell
[x] removed some repeated text (jupyter error?)
[x] S 3.2 Option 2, says "if desirable" but could more guidance be provided to users, example situations why that option would be better, to help users choose between options

beckynevin commented 6 months ago

@MelissaGraham , completed my to do list, this is ready for another look-over by you. I offered more guidance in part 3 for manifest file creation. Do you think it's contradictory to say "PIs are welcome to create their own manifest file. This is not the recommended option for PIs new to the citizen science pipeline."

beckynevin commented 6 months ago

Also, I think we need a better name for this notebook before we officially merge to main. Citizen_Science_Testing.ipynb makes it seem like it's still in development. The name should tell a user what the notebook does (send images to Zooniverse) and the name should also demonstrate the order to run the notebooks in (that this one should be run first).

What about 01_Introduction_to_Citsci_Pipeline.ipynb? We could name the variable_stars notebook something like 02_Send_Flipbook_Variable_Stars_Imaging.ipynb. Thoughts? @MelissaGraham @clareh @ericdrosas87 @bnord

MelissaGraham commented 6 months ago

@MelissaGraham , completed my to do list, this is ready for another look-over by you. I offered more guidance in part 3 for manifest file creation. Do you think it's contradictory to say "PIs are welcome to create their own manifest file. This is not the recommended option for PIs new to the citizen science pipeline."

Yes that sounds reasonable. It's not recommended b/c it's a little harder, yeah?

MelissaGraham commented 6 months ago

Also, I think we need a better name for this notebook before we officially merge to main. Citizen_Science_Testing.ipynb makes it seem like it's still in development. The name should tell a user what the notebook does (send images to Zooniverse) and the name should also demonstrate the order to run the notebooks in (that this one should be run first).

What about 01_Introduction_to_Citsci_Pipeline.ipynb? We could name the variable_stars notebook something like 02_Send_Flipbook_Variable_Stars_Imaging.ipynb. Thoughts? @MelissaGraham @clareh @ericdrosas87 @bnord

"01_Introduction_to ...", classic standard, that'll work fine, IMO.