Skip to content

Commit fa07277

Browse files
committed
Add instructions for citing this code
- Add a CITATION.cff file - Add instructions in the README.md file
1 parent cae4cde commit fa07277

File tree

2 files changed

+70
-5
lines changed

2 files changed

+70
-5
lines changed

CITATION.cff

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
cff-version: 1.2.0
2+
title: COMPASS data reduction pipeline
3+
message: >-
4+
If you use this software, please cite it using the metadata from
5+
this file. Please also cite Jørgensen et al. (2026) to refer to
6+
COMPASS large program, and Plunkett, Maret et al. (2026) to refer to
7+
the COMPASS data reduction approach.
8+
type: software
9+
authors:
10+
- family-names: Maret
11+
given-names: Sébastien
12+
email: sebastien.maret@univ-grenoble-alpes.fr
13+
affiliation: "Univ. Grenoble Alpes, CNRS, IPAG"
14+
orcid: "https://orcid.org/0000-0003-1104-4554"
15+
- family-names: Plunkett
16+
given-names: Adele
17+
affiliation: "National Radio Astronomy Observatory"
18+
orcid: "https://orcid.org/0000-0002-9912-5705"
19+
- family-names: Jørgensen
20+
given-names: Jes Kristian
21+
affiliation: "Niels Bohr Institute, University of Copenhagen"
22+
orcid: "https://orcid.org/0000-0001-9133-8047"
23+
abstract: >
24+
Data reduction pipeline for COMPASS (Complex Organic
25+
Molecules in Protostars with ALMA Spectral Surveys), an
26+
ALMA Large Program to systematically characterize the
27+
presence of complex organic molecules of a sample of 11
28+
deeply embedded low-mass protostars through unbiased
29+
spectral surveys.
30+
license: BSD-3-Clause
31+
#identifiers:
32+
# - type: swh
33+
# value:
34+
references:
35+
- title: "COMPASS: Complex Organic Molecules in Protostars with ALMA Spectral Surveys: Overview of the ALMA Large Program"
36+
type: article
37+
authors:
38+
- family-names: Jørgensen
39+
given-names: Jes Kristian
40+
journal: "Astronomy & Astrophysics"
41+
#volume:
42+
#pages:
43+
year: 2026
44+
#doi:
45+
scope: "Cite this paper to reference the COMPASS large program."
46+
- title: "COMPASS: Approach to data reduction and products for line-rich broadband (sub-)millimetre spectra"
47+
type: article
48+
authors:
49+
- family-names: Plunkett
50+
given-names: Adele
51+
orcid: "https://orcid.org/0000-0002-9912-5705"
52+
journal: "Astronomy & Astrophysics"
53+
#volume:
54+
#pages:
55+
year: 2026
56+
#doi:
57+
scope: "Cite this paper to reference the approach used for the reduction of the COMPASS data."

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# COMPASS data reduction
1+
# COMPASS data reduction pipeline
22

3-
This repository contains the data reduction scripts for
3+
This repository contains the data reduction pipeline for
44
[COMPASS](https://erda.ku.dk/vgrid/COMPASS/) (Complex Organic
55
Molecules in Protostars with ALMA Spectral Surveys), an [ALMA Large
66
Program](https://almascience.eso.org/alma-data/lp) to systematically
77
characterize the presence of complex organic molecules of a sample of
88
11 deeply embedded low-mass protostars through unbiased spectral
99
surveys.
1010

11-
The data reduction is done with
12-
[IMAGER](https://imager.oasu.u-bordeaux.fr), an interferometric
13-
imaging package.
11+
The data reduction pipeline is implemented using
12+
[IMAGER](https://imager.oasu.u-bordeaux.fr), an
13+
interferometric imaging package.
1414

1515
## Prerequisites
1616

@@ -285,3 +285,11 @@ be deleted with the `clean` argument:
285285

286286
This avoids side effects when running the reduction script several
287287
times.
288+
289+
## Citing this repository
290+
291+
If you use this software in your work, please cite it using the
292+
metadata from the [citation file](CITATION.cff). Please also cite
293+
Jørgensen et al. (2026) to refer to COMPASS large program, and
294+
Plunkett, Maret et al. (2026) to refer to the COMPASS data reduction
295+
approach.

0 commit comments

Comments
 (0)