cta-observatory / ctapipe

Low-level data processing pipeline software for CTAO or similar arrays of Imaging Atmospheric Cherenkov Telescopes
https://ctapipe.readthedocs.org
BSD 3-Clause "New" or "Revised" License
63 stars 266 forks source link

Use zenodo to get a DOI #678

Closed t-fi closed 4 years ago

t-fi commented 6 years ago

I need to calculate the hillas parameters in a experimental analysis framework as part of a masters thesis. The routines in ctapipe would be very handy, since they allow arbitrary camera geometries and are conveniently written in python. The thesis itself is not directly connected to CTA.

The routines in question are implemented in: https://github.com/cta-observatory/ctapipe/blob/39cf9af6df8ffed682982aa40a0581d722db76a3/ctapipe/image/hillas.py#L37 https://github.com/cta-observatory/ctapipe/blob/39cf9af6df8ffed682982aa40a0581d722db76a3/ctapipe/image/hillas.py#L162 https://github.com/cta-observatory/ctapipe/blob/39cf9af6df8ffed682982aa40a0581d722db76a3/ctapipe/image/hillas.py#L317 https://github.com/cta-observatory/ctapipe/blob/39cf9af6df8ffed682982aa40a0581d722db76a3/ctapipe/image/hillas.py#L488

How do I properly reference the work? Is it enough to include BSD-3?

And as a bonus: Which of the four implementations would you suggest to use?

kosack commented 6 years ago

Since we don't have a publication yet, I'd say you can reference CTA Observatory and link to this github site (not sure if you need to mention the license, but it can't hurt). You should also reference one of the papers that the algorithms are based on probably, which are listed in the docstrings.

maxnoe commented 6 years ago

We should get a doi for this repo: https://guides.github.com/activities/citable-code/

dneise commented 6 years ago

Which of the four implementations would you suggest to use?

I assume this might answer your question. At least I interpreted these lines as a recommendation by the original author which version to use...

https://github.com/cta-observatory/ctapipe/blob/39cf9af6df8ffed682982aa40a0581d722db76a3/ctapipe/image/hillas.py#L661-L662

maxnoe commented 4 years ago

Done