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

Clarifying pedagogy #48

Closed beckynevin closed 1 year ago

beckynevin commented 1 year ago

I've made some pedagogical changes to Citizen_Science_Testing.ipynb. In the process, there are also changes to Citizen_Science_SDK.ipynb and utils.py. Many of the functions have been moved to these two 'utilities'. Also let me know what you think about the grey text, I was trying to get it to contrast with the hyperlinks which are blue and the cell code output (which is black) while still being colorblind friendly.

ericdrosas87 commented 1 year ago

Go ahead and merge your SDK notebook changes as-is since I will pretty much be gutting it out with the EPO-8274 branch, and merging your SDK notebook changes here into the new rubin_citsci_core_pipeline.py script.

ericdrosas87 commented 1 year ago

In this notebook, we include an example of creating a citizen science project on Zooniverse, sending data from RSP to Zooniverse, and retrieving the results of the Zooniverse classification.

I suggest changing the wording here since the notebooks do not actually create the Zooniverse project - that step must be done prior to using the notebooks. We're simply adding a subject set to an existing project.

ericdrosas87 commented 1 year ago

I've noticed quote a few <font color='#5A5A5A'>...</font> tags throughout the Testing notebook. Rather than rely on the <font> tag and hardcoding the color code you may find it easier to declare some CSS styling like:

.description-text {
    color: #5A5A5A;
}

And then you can just use a <span> tag with a class like <span class="description-text">...</span> rather than the font tag with the hardcoded color code. That way if you ever want to change the tone of the color you only need to do it in one place.

This StackOverflow Q&A may be helpful in accomplishing this if you choose to implement this change.

beckynevin commented 1 year ago

In this notebook, we include an example of creating a citizen science project on Zooniverse, sending data from RSP to Zooniverse, and retrieving the results of the Zooniverse classification.

I suggest changing the wording here since the notebooks do not actually create the Zooniverse project - that step must be done prior to using the notebooks. We're simply adding a subject set to an existing project.

Great comment, I'm condensing the first two paragraphs of this section into one and being clear that this does not create the zooniverse project.