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

Added cell to create a project from a template #107

Merged
merged 3 commits into from
Jul 2, 2024

Conversation

ericdrosas87
Copy link
Contributor

Added cell to create a project from a template to both 01 and 02 notebooks. Also cleaned up some cells and wording regarding upgrading the rubin.citsci package.

Added cell to create a project from a template
@ericdrosas87 ericdrosas87 linked an issue Jun 10, 2024 that may be closed by this pull request
"A \"slug\" is the string of your Zooniverse username and your project name without the leading forward slash, for instance: \"username/project-name\". [Click here for more details](https://www.zooniverse.org/talk/18/967061?comment=1898157&page=1).\n"
"A \"slug\" is the string of your Zooniverse username and your project name without the leading forward slash, for instance: \"username/project-name\". [Click here for more details](https://www.zooniverse.org/talk/18/967061?comment=1898157&page=1).\n",
"\n",
"**If you have __not__ yet created a Zooniverse project do not provide a `slug_name` and run the subsequent cell**"
Copy link
Collaborator

@beckynevin beckynevin Jun 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend we change this to:
"The rubin.citsci package includes a method that creates a Zooniverse project from template. If you wish to use this feature, do not provide a slug_name and run the subsequent cell."

"tags": []
},
"source": [
"**Run the following cell if you would like to create a new Zooniverse project**"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest changing this to:
"Run the following cell if you would like to create a new Zooniverse project from (the?) template"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to Run the following cell if you would like to create a new Zooniverse project from the Vera Rubin template - let me know what you think!

},
"outputs": [],
"source": [
"cit_sci_pipeline.project = cit_sci_pipeline.create_new_project_from_template()"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something else to discuss is that people might still run this cell even if they do define a slugname. In that case, we would probably need to add some other controls, because do we want people to still be able to create a template project even if they separately defined the slug?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll address this in a future PR about guardrails.

},
"outputs": [],
"source": [
"cit_sci_pipeline.project = cit_sci_pipeline.create_new_project_from_template()"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My other thought here is that do we need to define the cit_sci_pipeline.project = part or should we just do _ = since we don't use it later?

Copy link
Contributor Author

@ericdrosas87 ericdrosas87 Jun 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cit_sci_pipeline.project is used within the rubin.citsci package, but technically it's not necessary to declare it in the notebook itself since that already happens in the method - I'll remove the cit_sci_pipeline.project part of this line

Updated text for creating project/template
No longer using return val from create_new_project_from_template()
@beckynevin beckynevin merged commit dfa30bc into main Jul 2, 2024
2 checks passed
@beckynevin beckynevin deleted the 106-update-notebooks-with-copy-project-cell branch July 2, 2024 22:16
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

Successfully merging this pull request may close these issues.

Update 01 & 02 citSci notebooks with copy-project cell
2 participants