Skip to content

Update codemeta.json#1606

Merged
namurphy merged 15 commits intoPlasmaPy:mainfrom
namurphy:codemeta-0.8.0
Jul 1, 2022
Merged

Update codemeta.json#1606
namurphy merged 15 commits intoPlasmaPy:mainfrom
namurphy:codemeta-0.8.0

Conversation

@namurphy
Copy link
Copy Markdown
Member

This PR updates our CodeMeta file to be consistent with our requirements and the updated authors list in #1599.

@namurphy namurphy added this to the 0.8.0 milestone Jun 29, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 29, 2022

Codecov Report

Merging #1606 (8aa50a3) into main (d2ab647) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1606   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files          83       83           
  Lines        7961     7961           
=======================================
  Hits         7739     7739           
  Misses        222      222           
Impacted Files Coverage Δ
plasmapy/analysis/nullpoint.py 98.53% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d2ab647...8aa50a3. Read the comment docs.

@namurphy
Copy link
Copy Markdown
Member Author

I'm wondering if it would be easiest to do this by addressing #1602 directly, since the information is already in credits.rst. Hm...

namurphy added 4 commits June 29, 2022 19:27
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.
@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Jun 30, 2022
@namurphy namurphy marked this pull request as ready for review June 30, 2022 22:42
@namurphy namurphy requested a review from rocco8773 June 30, 2022 23:05
Comment thread docs/about/credits.rst
* :user:`Brian Goodall <goodab>`
* :user:`Brigitta Sipőcz <bsipocz>` (:orcid:`0000-0002-3713-6337`)
* :user:`Bryan Foo <bryancfoo>` (:orcid:`0000-0001-5308-6870`)
* :user:`Bryan Foo <bryancfoo>`
Copy link
Copy Markdown
Member Author

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.

@namurphy
Copy link
Copy Markdown
Member Author

namurphy commented Jul 1, 2022

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. 📚

@namurphy namurphy added the status: ready for review PRs that are ready for code review label Jul 1, 2022
Comment thread change_authors_to_dict.ipynb Outdated
@@ -0,0 +1,843 @@
{
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member Author

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.

Copy link
Copy Markdown
Member Author

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.

Comment thread codemeta.json Outdated
Comment thread changelog/1606.trivial.rst Outdated
rocco8773
rocco8773 previously approved these changes Jul 1, 2022
Co-authored-by: Erik Everson <eteverson@gmail.com>
@namurphy
Copy link
Copy Markdown
Member Author

namurphy commented Jul 1, 2022

@rocco8773 — I committed your suggestion, which reset the review. Could you approve it again? Thanks!

@namurphy namurphy enabled auto-merge (squash) July 1, 2022 22:01
@namurphy namurphy merged commit 42a7d8c into PlasmaPy:main Jul 1, 2022
@namurphy namurphy removed the status: ready for review PRs that are ready for code review label Aug 15, 2022
@namurphy namurphy deleted the codemeta-0.8.0 branch May 24, 2023 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PlasmaPy Docs at http://docs.plasmapy.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants