Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-36808: Add citation information #751

Merged
merged 7 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
cff-version: 1.2.0
message: "Please cite the following when using this software: https://doi.org/10.1117/12.2629569"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the commonly accepted paradigm is to say something like "If you use this software, please cite it using this metadata." so that you don't have to update the link twice (here in the message and later in the preferred-citation).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, although I was worried that might lead to an attempt to cite the software itself which doesn't have a DOI or ASCL ID and so thought I should be explicit.

authors:
- name: "Rubin Observatory Data Management Team"
- family-names: Jenness
timj marked this conversation as resolved.
Show resolved Hide resolved
given-names: Tim
orcid: "https://orcid.org/0000-0001-5982-167X"
- family-names: Bosch
given-names: James F.
orcid: "https://orcid.org/0000-0003-2759-5764"
- family-names: Salnikov
given-names: Andrei
orcid: "https://orcid.org/0000-0002-3623-0161"
- family-names: Lust
given-names: Nate B.
orcid: "https://orcid.org/0000-0002-4122-9384"
- family-names: Pease
given-names: Nathan M.
orcid: "https://orcid.org/0000-0002-9701-5975"
- family-names: Gower
given-names: Michelle
orcid: "https://orcid.org/0000-0001-9513-6987"
- family-names: Kowalik
given-names: Mikolaj
orcid: "https://orcid.org/0000-0002-9801-5969"
- family-names: Schellart
given-names: Pim
orcid: "https://orcid.org/0000-0002-8324-0880"
- family-names: Irving
given-names: David H.
orcid: "https://orcid.org/0009-0005-9099-4970"
title: "lsst-daf-butler: Abstracted Data Access of Astronomical Data"
repository-code: "https://github.com/lsst/daf_butler"
identifiers:
- type: swh
value: "swh:1:dir:ef572b4bb431e898d279d4de786bc462bd5ca466"
abstract: |
The Rubin Observatory's Data Butler is designed to allow data file location
and file formats to be abstracted away from the people writing the science
pipeline algorithms. The Butler works in conjunction with the workflow graph
builder to allow pipelines to be constructed from the algorithmic tasks.
preferred-citation:
type: article
title: "The Vera C. Rubin Observatory Data Butler and pipeline execution system"
identifiers:
- type: "doi"
value: "10.1117/12.2629569"
- type: "bibcode"
value: "2022SPIE12189E..11J"
authors:
- family-names: Jenness
given-names: Tim
orcid: "https://orcid.org/0000-0001-5982-167X"
- family-names: Bosch
given-names: James F.
orcid: "https://orcid.org/0000-0003-2759-5764"
- family-names: Salnikov
given-names: Andrei
orcid: "https://orcid.org/0000-0002-3623-0161"
- family-names: Lust
given-names: Nate B.
orcid: "https://orcid.org/0000-0002-4122-9384"
- family-names: Pease
given-names: Nathan M.
orcid: "https://orcid.org/0000-0002-9701-5975"
- family-names: Gower
given-names: Michelle
orcid: "https://orcid.org/0000-0001-9513-6987"
- family-names: Kowalik
given-names: Mikolaj
- family-names: Dubois-Felsmann
given-names: Gregory P.
orcid: "https://orcid.org/0000-0003-1598-6979"
- family-names: Mueller
given-names: Fritz
orcid: "https://orcid.org/0000-0002-7061-4644"
- family-names: Schellart
given-names: Pim
orcid: "https://orcid.org/0000-0002-8324-0880"
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
[![codecov](https://codecov.io/gh/lsst/daf_butler/branch/main/graph/badge.svg?token=2BUBL8R9RH)](https://codecov.io/gh/lsst/daf_butler)

LSST Data Access framework described in [arXiv:2206.14941](https://arxiv.org/abs/2206.14941).
Please cite [the SPIE paper](https://doi.org/10.1117/12.2629569) when using this software.

This is a **Python 3 only** package (we assume Python 3.10 or higher).
This is a **Python 3 only** package (we assume Python 3.11 or higher).

* SPIE Paper from 2022: [The Vera C. Rubin Observatory Data Butler and Pipeline Execution System](https://arxiv.org/abs/2206.14941)
* SPIE Paper from 2022: [The Vera C. Rubin Observatory Data Butler and Pipeline Execution System](https://doi.org/10.1117/12.2629569) ([arXiv](https://arxiv.org/abs/2206.14941))
* ADASS paper from 2019: [Abstracting the Storage and Retrieval of Image Data at the LSST](https://ui.adsabs.harvard.edu/abs/2019ASPC..523..653J/abstract).
* Early design note: [DMTN-056](https://dmtn-056.lsst.io)

PyPI: [lsst-daf-butler](https://pypi.org/project/lsst-daf-butler/)

This software is dual licensed under the GNU General Public License (version 3 of the License, or (at your option) any later version, and also under a 3-clause BSD license.
This software is dual licensed under the GNU General Public License (version 3 of the License, or (at your option) any later version, and also under a 3-clause BSD license).
Recipients may choose which of these licenses to use; please see the files gpl-3.0.txt and/or bsd_license.txt, respectively.
Loading