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.

Sign up for GitHub

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

Jump to bottom

Add project authorship/citation/funding metadata #286

Merged
merged 15 commits into from
Sep 20, 2023
Merged

Add project authorship/citation/funding metadata #286

merged 15 commits into from
Sep 20, 2023

Conversation

MattF-NSIDC
Copy link

@MattF-NSIDC MattF-NSIDC commented Aug 24, 2023 •
edited by mfisher87
Loading

TODO:

  • Add orcid
  • Add other authors
  • Review abstract
  • Review keywords
  • Add DOI (chicken-and-egg problem; we need to do a release to trigger Zenodo to generate a DOI, then we can update this file)
  • Add grant number
  • Consider other references. Are there other DOIs that are related to this work?
  • Consider how to automate version bumps in CITATION.cff. bump-my-version?

@MattF-NSIDC MattF-NSIDC marked this pull request as draft August 24, 2023 22:27
@github-actions
Copy link

github-actions bot commented Aug 24, 2023 •
edited
Loading

Binder 👈 Launch a binder notebook on this branch for commit 69274ad

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 10a56b7

Binder 👈 Launch a binder notebook on this branch for commit 9f37ecc

Binder 👈 Launch a binder notebook on this branch for commit d942100

Binder 👈 Launch a binder notebook on this branch for commit fb435de

Binder 👈 Launch a binder notebook on this branch for commit 3729650

Binder 👈 Launch a binder notebook on this branch for commit ac35fff

Binder 👈 Launch a binder notebook on this branch for commit 7f30fdc

Binder 👈 Launch a binder notebook on this branch for commit 76ba5a7

Binder 👈 Launch a binder notebook on this branch for commit 557d13b

Binder 👈 Launch a binder notebook on this branch for commit d744400

Binder 👈 Launch a binder notebook on this branch for commit 4dd2aab

@MattF-NSIDC
Copy link
Author

@betolink I flipped the Zenodo switch; you should be able to see this if you log in on your GitHub account. Once we merge this PR and make a release, we should have our DOI.

https://zenodo.org/account/settings/github/repository/nsidc/earthaccess

@MattF-NSIDC
Copy link
Author

@jrbourbeau would you mind pushing a commit to this PR adding your preferred email in pyproject.toml?

@mfisher87
Copy link
Collaborator

Should we also update the contributing document to request people to add themselves to the authors list when they make a contribution?

@mfisher87
Copy link
Collaborator

mfisher87 commented Aug 28, 2023 •
edited
Loading

@betolink can you add your orcid and other authors to this PR? Also grant number? :)

@MattF-NSIDC MattF-NSIDC requested a review from betolink August 28, 2023 19:42
@betolink
Copy link
Member

@jules32 do you know the award number for openscapes? this is for the Zenodo record.

@betolink
Copy link
Member

also if we can have all the contributors' ORCID numbers that'd be great! @jhkennedy @JessicaS11 @asteiker @cgentemann @jroebuck932 et al.

@jhkennedy
Copy link
Collaborator

@betolink here's my ORCID: 0000-0002-9348-693X

@jules32
Copy link
Contributor

jules32 commented Aug 29, 2023

Hi @betolink !

Award number is NASA ROSES 80NSSC21K0564 Award # 20-TWSC20-2-0003
My ORCID: https://orcid.org/0000-0003-1682-3872

@jrbourbeau
Copy link
Collaborator

@jrbourbeau would you mind pushing a commit to this PR adding your preferred email in pyproject.toml?

Apologies for the delayed response. Just pushed my email 👍

@andypbarrett
Copy link
Collaborator

@betolink here's my ORCID 0000-0003-4394-5445

@asteiker
Copy link
Member

asteiker commented Sep 5, 2023

@betolink Here's my ORCID: 0000-0002-3039-0260 Thanks!

@mfisher87
Copy link
Collaborator

@jrbourbeau do you have an ORCiD?

@jrbourbeau
Copy link
Collaborator

Ah, yeah I forgot I had one (had to dust it off 🙂 ) 0000-0003-2164-7789

@mfisher87
Copy link
Collaborator

Thanks, James :)

betolink and others added 3 commits September 19, 2023 11:07
@betolink
added Jessica to contributors list
3729650
@mfisher87
Add bump-my-version for updating version numbers
b66c5ca 
Citation metadata can't read the version number of our python project
dynamically. So we either need to maintain it manually or use a
text-based replacement like this.
@mfisher87
Update docs with release process details
ac35fff
@mfisher87 mfisher87 marked this pull request as ready for review September 19, 2023 16:12
@mfisher87
Copy link
Collaborator

@betolink this is ready for a review, can you take a final peek keeping in mind the checklist in the description?

@mfisher87 mfisher87 changed the title [WIP] Add project metadata Add project authorship/citation metadata Sep 19, 2023
@mfisher87 mfisher87 changed the title Add project authorship/citation metadata Add project authorship/citation/funding metadata Sep 19, 2023
betolink
betolink previously approved these changes Sep 20, 2023
View reviewed changes
Copy link
Member

@betolink betolink left a comment

Choose a reason for hiding this comment

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

@mfisher87 circling back, the abstract is WIP and we can take a look at it after the UWG, I think we covered the core items on the checklist. Thanks for updating this PR, should we merge and release v0.5.4?

@mfisher87
Copy link
Collaborator

I think this is good to merge! 🚀 Would you like to do the release and in the process validate the new release instructions? :)

I pushed two more commits to fix a mistake and add an automation I missed.

@mfisher87
Copy link
Collaborator

Woops... missed one more thing.

@battistowx
Copy link
Collaborator

@betolink Here's mine: https://orcid.org/0000-0002-9608-3634

mfisher87
mfisher87 reviewed Sep 20, 2023
View reviewed changes
CONTRIBUTING.md
3. Update the documentation and the README.md with details of changes to the interface,
this includes new environment variables, function names, decorators, etc.
3. Update `CHANGELOG.md` with details about your change in a section titled
`Unreleased`. If one does not exist, please create one.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Feels like we should have a PR template with a checklist for things like this!

@mfisher87
Copy link
Collaborator

If you didn't get added in this PR, please open another PR to add yourself following this example. It's merge time!

@mfisher87 mfisher87 merged commit fb642b3 into main Sep 20, 2023
1 check passed
@mfisher87 mfisher87 deleted the add-code-metadata branch September 20, 2023 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mfisher87 mfisher87 mfisher87 approved these changes

@betolink betolink betolink left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@MattF-NSIDC @mfisher87 @betolink @jhkennedy @jules32 @jrbourbeau @andypbarrett @asteiker @battistowx