Consider providing a way to cite this package in the scientific literature

CCSDSPy / ccsdspy

I/O interface and utilities for CCSDS binary spacecraft data in Python. Library used in flight missions at NASA, NOAA, and SWRI

https://ccsdspy.org

BSD 3-Clause "New" or "Revised" License

75 stars 18 forks source link

Consider providing a way to cite this package in the scientific literature #43

Closed ehsteve closed 1 year ago

ehsteve commented 1 year ago

Scientific packages (e.g. sunpy, scipy) provide a way to cite their use by providing a doi (e.g. scipy). There are many ways to get a doi associated with the package

zenodo - allows you to get a doi without writing a paper, sunpy does this for every release.
Journal of Open Source Software (JOSS allows you to get a doi by submitting to them a short narrative paper and the package. Your code is actually reviewed before being accepted.
submitting a paper to an actual journal. Many journals will now accept papers about software tools.

Of course, you do not have to do just one. SunPy has actually done all of them! See this page.

ddasilva commented 1 year ago

I agree, this is something we want to do. We should start with zenodo in the short term, and draft a publication after we implement enough features to say we are one iteration of "complete vision". I think to get to that point we would want to implement support for some common flight software packet definition export formats (like XTCE) and provide a few more utils like python -m split_by_apid.

As far as "actual journals", I don't know where this would fit, maybe in one of the AIAA or IEEE aerospace journals?

jmbhughes commented 1 year ago

This is a great idea. We'd love to cite and give you credit in a PUNCH paper. Zenodo is very easy to set up in my experience. You essentially just give it permission to access your GitHub and then select which repo to make a DOI for.

ehsteve commented 1 year ago

@ddasilva I would recommend you do it like we do for SunPy. We publish the library and create new DOIs for each release on Zenodo. See sunpy|Zenedo. That way users can cite a specific release. For reference here is the Citing SunPy page.

ddasilva commented 1 year ago

I made a zenodo DOI for this. Remaining work for this ticket is to add it to the README and the website: https://zenodo.org/record/7819991

ehsteve commented 1 year ago

Should this issue be closed? Or do you want to leave it open for discuss other ways to cite like a paper or something?

ddasilva commented 1 year ago

Not yet, I want to add a page to the website and the link to the README

ddasilva commented 1 year ago

The DOI has been added to the readme and the website. I am closing this issue, feel free to reopen or make a new issue if further discussion is desired