Skip to content

Commit 5427634

Browse files
jeffrileyjeffriley
authored
Merge pull request #1435 from TeamCOMPAS/docs
Update references, include COMPAS methods paper 2
2 parents c780a50 + be9ca2a commit 5427634

File tree

4 files changed

+79
-46
lines changed

4 files changed

+79
-46
lines changed

‎README.md‎

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,55 @@ https://compas.science/docs
1616
Please email your queries to compas-user@googlegroups.com. You are also welcome to join the [COMPAS User Google Group](https://groups.google.com/forum/#!members/compas-user) to engage in discussions with COMPAS users and developers.
1717

1818
## Acknowledgements
19-
If you use this code or parts of this code for results presented in a scientific publication, we would greatly appreciate if you send us your paper reference and make your input settings and output data publicly available by uploading it to the [COMPAS Zenodo community](https://zenodo.org/communities/compas/). Please also kindly include citations to our COMPAS methods paper https://ui.adsabs.harvard.edu/abs/2021arXiv210910352T/abstract. As the public COMPAS code is a product of work by the entire COMPAS collaboration over many years, we kindly request that, in recognition of this team effort, the paper is cited as “Team COMPAS: J. Riley et al.”. An example bibtex code is:
20-
21-
@ARTICLE{2022ApJS..258...34R,
22-
author = {{Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold and {Team Compas}},
19+
If you use this code or parts of this code for results presented in a scientific publication, we would greatly appreciate if you send us your paper reference and make your input settings and output data
20+
publicly available by uploading it to the [COMPAS Zenodo community](https://zenodo.org/communities/compas/). Please also kindly include citations to our COMPAS methods papers
21+
https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R
22+
and
23+
https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T .
24+
As the public COMPAS code is a product of work by the entire COMPAS collaboration over many years, we kindly request that, in recognition of
25+
this team effort, the papers are cited as “Team COMPAS: J. Riley et al. (2021)” and "Team COMPAS: I. Mandel et al. (2025). Example bibtex codes are:
26+
27+
@ARTICLE{compas2021,
28+
author = {{Team COMPAS: Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold},
2329
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}",
2430
journal = {\apjs},
25-
keywords = {1622, 154, 1108, 162, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Solar and Stellar Astrophysics},
31+
keywords = {1622, 154, 1108, 162},
2632
year = 2022,
2733
month = feb,
2834
volume = {258},
2935
number = {2},
3036
eid = {34},
3137
pages = {34},
3238
doi = {10.3847/1538-4365/ac416c},
33-
archivePrefix = {arXiv},
34-
eprint = {2109.10352},
35-
primaryClass = {astro-ph.IM},
3639
adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R},
3740
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
3841
}
3942

43+
@ARTICLE{compas2025,
44+
author = {{Team COMPAS: Mandel}, Ilya and {Riley}, Jeff and {Boesky}, Adam and {Brcek}, Adam and {Hirai}, Ryosuke and {Kapil}, Veome and {Lau}, Mike Y.~M. and {Merritt}, JD and {Rodr{\'\i}guez-Segovia}, Nicol{\'a}s and {Romero-Shaw}, Isobel and {Song}, Yuzhe and {Stevenson}, Simon and {Vajpeyi}, Avi and {van Son}, L.~A.~C. and {Vigna-G{\'o}mez}, Alejandro and {Willcox}, Reinhold},
45+
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS: Methods Paper II}",
46+
journal = {\apjs},
47+
keywords = {Binary stars, Stellar populations, Stellar evolution, Stellar evolutionary models, Stellar remnants, 154, 1622, 1599, 2046, 1627, Solar and Stellar Astrophysics, High Energy Astrophysical Phenomena, Instrumentation and Methods for Astrophysics},
48+
year = 2025,
49+
month = sep,
50+
volume = {280},
51+
number = {1},
52+
eid = {43},
53+
pages = {43},
54+
doi = {10.3847/1538-4365/adf8d0},
55+
archivePrefix = {arXiv},
56+
eprint = {2506.02316},
57+
primaryClass = {astro-ph.SR},
58+
adsurl = {https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T},
59+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
60+
}
4061

41-
Note that the preferred acknowledgement relies on \noopsort and cites the paper as TEAM COMPAS; Riley et al.; to make it work, you'll have to include the following line at the start of your bibtex file:
42-
@PREAMBLE{ {\providecommand{\noopsort}[1]{}} }
62+
##Note that the preferred acknowledgement relies on \noopsort and cites the paper as TEAM COMPAS; Riley et al.; to make it work, you'll have to include the following line at the start of your bibtex file:
63+
##@PREAMBLE{ {\providecommand{\noopsort}[1]{}} }
4364

44-
and change the author line in the bib entry to:
65+
##and change the author line in the bib entry to:
4566

46-
author = {{\noopsort{Team COMPAS}}{Team COMPAS: Riley, J.} and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-Gomez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold}
67+
##author = {{\noopsort{Team COMPAS}}{Team COMPAS: Riley, J.} and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-Gomez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold}
4768

4869

4970

‎online-docs/COMPAS-2021methodsPaper.bib‎

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
1-
@ This formats the citation for the COMPAS Methods Paper in our preferred style
2-
@ The following PREAMBLE entry must appear at the top of the bibtex file
3-
4-
@PREAMBLE{ {\providecommand{\noopsort}[1]{}} }
5-
6-
@ARTICLE{2022ApJS..258...34R,
7-
author = {{Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold and {Team Compas}},
8-
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}",
9-
journal = {\apjs},
10-
keywords = {1622, 154, 1108, 162, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Solar and Stellar Astrophysics},
11-
year = 2022,
12-
month = feb,
13-
volume = {258},
14-
number = {2},
15-
eid = {34},
16-
pages = {34},
17-
doi = {10.3847/1538-4365/ac416c},
18-
archivePrefix = {arXiv},
19-
eprint = {2109.10352},
20-
primaryClass = {astro-ph.IM},
21-
adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R},
22-
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
23-
}
24-
25-
1+
@ARTICLE{COMPAS:2021,
2+
author = {{Team COMPAS: Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold},
3+
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}",
4+
journal = {\apjs},
5+
keywords = {1622, 154, 1108, 162},
6+
year = 2022,
7+
month = feb,
8+
volume = {258},
9+
number = {2},
10+
eid = {34},
11+
pages = {34},
12+
doi = {10.3847/1538-4365/ac416c},
13+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R},
14+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
15+
}

‎online-docs/COMPAS-2025methodsPaper.bib‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
@ARTICLE{COMPAS:2025,
22
author = {{Team COMPAS: Mandel}, Ilya and {Riley}, Jeff and {Boesky}, Adam and {Brcek}, Adam and {Hirai}, Ryosuke and {Kapil}, Veome and {Lau}, Mike Y.~M. and {Merritt}, JD and {Rodr{\'\i}guez-Segovia}, Nicol{\'a}s and {Romero-Shaw}, Isobel and {Song}, Yuzhe and {Stevenson}, Simon and {Vajpeyi}, Avi and {van Son}, L.~A.~C. and {Vigna-G{\'o}mez}, Alejandro and {Willcox}, Reinhold},
3-
title = "{Rapid stellar and binary population synthesis with COMPAS: methods paper II}",
4-
journal = {arXiv e-prints},
5-
keywords = {Solar and Stellar Astrophysics, High Energy Astrophysical Phenomena, Instrumentation and Methods for Astrophysics},
3+
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS: Methods Paper II}",
4+
journal = {\apjs},
5+
keywords = {Binary stars, Stellar populations, Stellar evolution, Stellar evolutionary models, Stellar remnants, 154, 1622, 1599, 2046, 1627, Solar and Stellar Astrophysics, High Energy Astrophysical Phenomena, Instrumentation and Methods for Astrophysics},
66
year = 2025,
7-
month = jun,
8-
eid = {arXiv:2506.02316},
9-
pages = {arXiv:2506.02316},
10-
doi = {10.48550/arXiv.2506.02316},
7+
month = sep,
8+
volume = {280},
9+
number = {1},
10+
eid = {43},
11+
pages = {43},
12+
doi = {10.3847/1538-4365/adf8d0},
1113
archivePrefix = {arXiv},
1214
eprint = {2506.02316},
1315
primaryClass = {astro-ph.SR},
14-
adsurl = {https://ui.adsabs.harvard.edu/abs/2025arXiv250602316M},
16+
adsurl = {https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T},
1517
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
1618
}

‎online-docs/refs.bib‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
@ARTICLE{compas2021,
3-
author = {{Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold and {Team Compas}},
3+
author = {{Team COMPAS: Riley}, Jeff and {Agrawal}, Poojan and {Barrett}, Jim W. and {Boyett}, Kristan N.~K. and {Broekgaarden}, Floor S. and {Chattopadhyay}, Debatri and {Gaebel}, Sebastian M. and {Gittins}, Fabian and {Hirai}, Ryosuke and {Howitt}, George and {Justham}, Stephen and {Khandelwal}, Lokesh and {Kummer}, Floris and {Lau}, Mike Y.~M. and {Mandel}, Ilya and {de Mink}, Selma E. and {Neijssel}, Coenraad and {Riley}, Tim and {van Son}, Lieke and {Stevenson}, Simon and {Vigna-G{\'o}mez}, Alejandro and {Vinciguerra}, Serena and {Wagg}, Tom and {Willcox}, Reinhold},
44
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}",
55
journal = {\apjs},
66
keywords = {1622, 154, 1108, 162, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Solar and Stellar Astrophysics},
@@ -18,6 +18,26 @@ @ARTICLE{compas2021
1818
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
1919
}
2020

21+
@ARTICLE{compas2025,
22+
author = {{Team COMPAS: Mandel}, Ilya and {Riley}, Jeff and {Boesky}, Adam and {Brcek}, Adam and {Hirai}, Ryosuke and {Kapil}, Veome and {Lau}, Mike Y.~M. and {Merritt}, JD and {Rodr{\'\i}guez-Segovia}, Nicol{\'a}s and {Romero-Shaw}, Isobel and {Song}, Yuzhe and {Stevenson}, Simon and {Vajpeyi}, Avi and {van Son}, L.~A.~C. and {Vigna-G{\'o}mez}, Alejandro and {Willcox}, Reinhold},
23+
title = "{Rapid Stellar and Binary Population Synthesis with COMPAS: Methods Paper II}",
24+
journal = {\apjs},
25+
keywords = {Binary stars, Stellar populations, Stellar evolution, Stellar evolutionary models, Stellar remnants, 154, 1622, 1599, 2046, 1627, Solar and Stellar Astrophysics, High Energy Astrophysical Phenomena, Instrumentation and Methods for Astrophysics},
26+
year = 2025,
27+
month = sep,
28+
volume = {280},
29+
number = {1},
30+
eid = {43},
31+
pages = {43},
32+
doi = {10.3847/1538-4365/adf8d0},
33+
archivePrefix = {arXiv},
34+
eprint = {2506.02316},
35+
primaryClass = {astro-ph.SR},
36+
adsurl = {https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T},
37+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
38+
}
39+
40+
2141

2242
@article{Barrett2018,
2343
title = "{Accuracy of inference on the physics of binary evolution from gravitational-wave observations}",

0 commit comments

Comments
 (0)