simpeg / aurora

software for processing natural source electromagnetic data
MIT License
14 stars 2 forks source link

Be able to Cite Aurora: Get a DOI #315

Closed kujaku11 closed 1 month ago

kujaku11 commented 8 months ago

@kkappler I want to cite Aurora but there's not a great way. A simple way to get your code citeable is to get a DOI. The easiest way is to go to https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content. Its nice too cause you don't have to update it, it will update with a release tag.

kkappler commented 8 months ago

@kujaku11 Thanks for the link. I have added aurora to zenodo. Looks like next release will trigger a DOI. Next release should (hopefully) be in January (fix_issue_36, add support for units) image

kujaku11 commented 8 months ago

@kkappler nice, you might want to make a new release just for zenodo to get it setup. Up to you. I can help if you need.

kkappler commented 8 months ago

@kujaku11 I'm good with creating a release but would like to get the outstanding PRs on mth5 and mt_metadata accepted so that the .github/workflows/tests.yaml can refer to main branches for the release.

@kujaku11 I requested reviews on these PRs, can you PTAL

kkappler commented 8 months ago

@kujaku11 Here is the zenodo DOI for v0.3.12

https://zenodo.org/records/10494538

Will wait until we can coordinate on updates of all mt packages for PyPI, and condaforge

kkappler commented 2 months ago

Will close this issue after the JOSS manuscript is accepted and merged into main.

This will also resolve

kkappler commented 1 month ago

Besides the old zenodo, we now have two new DOIs associated with the JOSS manuscript: