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

adding details in README file #50

Closed beckynevin closed 1 year ago

beckynevin commented 1 year ago

Hi @ericdrosas87 I'm updating our readme to have more details about the target notebooks. Feel free to add suggestions in this thread. Right now I've added the following text:

The Citizen_Science_Testing.ipynb is most relevant; it guides a PI through the process of sending data from the Rubin Science Platform (RSP) to the Zooniverse and retrieving classifications from Zooniverse.

The utils.py script contains general plotting, butler, and manifest utilities. If necessary, it can be modified carefully.

The rubin_citsci_core_pipeline.py script contains utilities related to the citizen science pipeline. Do not modify.

Additional notebooks are deprecated.

Is there a better way to suggest that people not look at the other notebooks?

ericdrosas87 commented 1 year ago

Is there a better way to suggest that people not look at the other notebooks?

We could create a folder named "Experimental Notebooks" or some such and put all the notebooks other than Citizen_Science_Testing.ipynb in there?

beckynevin commented 1 year ago

Is there a better way to suggest that people not look at the other notebooks?

We could create a folder named "Experimental Notebooks" or some such and put all the notebooks other than Citizen_Science_Testing.ipynb in there?

I love this idea. I can make this edit to the PR.