-
Notifications
You must be signed in to change notification settings - Fork 340
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
Update codemeta.json
#1606
Update codemeta.json
#1606
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1606 +/- ##
=======================================
Coverage 97.21% 97.21%
=======================================
Files 83 83
Lines 7961 7961
=======================================
Hits 7739 7739
Misses 222 222
Continue to review full report at Codecov.
|
I'm wondering if it would be easiest to do this by addressing #1602 directly, since the information is already in |
The notebook `change_authors_to_dict.ipynb` is what I used to transform the author list given in `docs/about/credits.rst` to the format used in codemeta.json. This notebook transformed names and ORCIDs but not GitHub handles. I ended up doing some stuff manually.
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
* :user:`Bryan Foo <bryancfoo>` (:orcid:`0000-0001-5308-6870`) | ||
* :user:`Bryan Foo <bryancfoo>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this ORCID in #1599, but I don't know if this is the correct ORCID.
After getting this pretty much done, I looked up Zenodo's FAQ and found that they haven't yet implemented their integration with CodeMeta. Zenodo does have an integration with Citation File Format (CFF), but I haven't found a way to convert CodeMeta to CFF that worked. But, if I upload the metadata to Zenodo manually, then there are tools that can take the Zenodo metadata and make them a CFF file, and once we have a CFF file, then we can convert that back to CodeMeta with existing tools. At the very least, this will make librarians happy. 📚 |
change_authors_to_dict.ipynb
Outdated
@@ -0,0 +1,843 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you wanting this to be in the root directory? I can see these being useful tools for the future, but having the functionality in the notebook in the root directory does not seem right. I would actually propose making plasmapy_helpers
package in the root directory that is ignored by find_packages()
so it's not distributed with plamsapy
. We can stuff plasmapy_helpers
with all the useful pkg management tools we can imagine.
For now, I suggest throwing this notebook into a root directory called notebooks_for_proto
since that directory is already listed as ignored by .gitignore
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! I meant to commit it temporarily so that it was in version control history for future me, but I had thought that I had deleted it.
But with that said, I do very much like the idea of having something akin to a plasmapy_helpers
directory that could include things like this. In the past I had wondered about a separate repo for things like this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correction: it looks like I already did delete that notebook.
Co-authored-by: Erik Everson <[email protected]>
@rocco8773 — I committed your suggestion, which reset the review. Could you approve it again? Thanks! |
This PR updates our CodeMeta file to be consistent with our requirements and the updated authors list in #1599.