search

jzuhone / pyxsim

Simulating X-ray observations from astrophysical sources.
http://hea-www.cfa.harvard.edu/~jzuhone/pyxsim
Other
20 stars 8 forks source link

Recommended Citation? #1

Open augustfly opened 8 years ago

augustfly commented 8 years ago

What is your recommended citation for this package?

Every time I say that it sounds super soft -- as if I'm washing over the details of the algorithms implemented and extended that so you so clearly mentioned in the ReadMe. So here is the long version:

How might a user of pyXSIM describe their use of this software package in the methods section of their paper in such a way that captures the algorithms behind it yet ascribes credit to you (et al.) as a (the) developer(s)?

Providing some template text of this (form of citation/mention) in the ReadMe would be a big plus.

jzuhone commented 8 years ago

Good question. The best thing to do is probably cite the SciPy proceeding, but I'll add that to the README.

Of course, even that is a bit out of date now since the software has been extracted from yt and new capabilities have been added. I should probably add pyXSIM to the ASCL.

augustfly commented 8 years ago

Sounds fine to me.

What is your opinion (yes your opinion!) on minting a Zenodo DOI for this package?

jzuhone commented 1 year ago

Hi @augustfly (sorry for such a long wait), but there is now a ASCL entry for pyXSIM:

https://ascl.net/1608.002

Zenodo makes sense, I'll look into it.