COMPAS

COMPAS: A rapid binary population synthesis suite - Published in JOSS (2022)

https://github.com/teamcompas/compas

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    16 of 44 committers (36.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

astronomy astrophysics

Scientific Fields

Mathematics Computer Science - 37% confidence
Last synced: 6 months ago · JSON representation

Repository

COMPAS rapid binary population synthesis code

Basic Info
  • Host: GitHub
  • Owner: TeamCOMPAS
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: dev
  • Homepage: http://compas.science
  • Size: 268 MB
Statistics
  • Stars: 77
  • Watchers: 11
  • Forks: 75
  • Open Issues: 22
  • Releases: 4
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License Code of conduct

README.md

COMPASlogo

Compact Object Mergers: Population Astrophysics & Statistics

COMPAS is a publicly available rapid binary population synthesis code (https://compas.science/) that is designed so that evolution prescriptions and model parameters are easily adjustable. COMPAS draws properties for a binary star system from a set of initial distributions, and evolves it from zero-age main sequence to the end of its life as two compact remnants. It has been used for inference from observations of gravitational-wave mergers, Galactic neutron stars, X-ray binaries, and luminous red novae.

Documentation

https://compas.science/docs

Contact

Please email your queries to compas-user@googlegroups.com. You are also welcome to join the COMPAS User Google Group to engage in discussions with COMPAS users and developers.

Acknowledgements

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. 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:

@ARTICLE{2022ApJS..258...34R, 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}}, title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}", journal = {\apjs}, keywords = {1622, 154, 1108, 162, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Solar and Stellar Astrophysics}, year = 2022, month = feb, volume = {258}, number = {2}, eid = {34}, pages = {34}, doi = {10.3847/1538-4365/ac416c}, archivePrefix = {arXiv}, eprint = {2109.10352}, primaryClass = {astro-ph.IM}, adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R}, adsnote = {Provided by the SAO/NASA Astrophysics Data System} }

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: @PREAMBLE{ {\providecommand{\noopsort}[1]{}} }

and change the author line in the bib entry to:

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}

In addition, we suggest to kindly include the two following papers:

  1. Stevenson S., Vigna-Gómez A., Mandel I., Barrett J. W., Neijssel C. J., Perkins D., de Mink S. E., 2017, Nature Communications, 8, 14906
  2. Vigna-Gómez A., Neijssel C. J., Stevenson S., Barrett J. W., Belczynski K., Justham S., de Mink S., Müller B., Podsiadlowski Ph., Renzo M., Szécsi D., Mandel I., 2018, MNRAS, 481, 4009

We also greatly appreciate an acknowledgement of the form:

Simulations in this paper made use of the COMPAS rapid binary population synthesis code (version X.X.X), which is freely available at http://github.com/TeamCOMPAS/COMPAS.

Furthermore,

  • If you use COMPAS's importance sampling algorithm STROOPWAFEL, please cite

    Broekgaarden F. S., Justham S., de Mink S. E., Gair J., Mandel I., Stevenson S., Barrett J. W., Vigna-Gómez A., Neijssel C. J., 2019, MNRAS, 490, 5228

  • If using the COMPAS model of gravitational wave selection effects, please cite

    Barrett J. W., Gaebel S. M., Neijssel C. J., Vigna-Gómez A., Stevenson S., Berry C. P. L., Farr W. M., Mandel I., 2018, MNRAS, 477, 4685

  • If using COMPAS's integration over cosmic star formation history, please cite

    Neijssel C. J., Vigna-Gómez A., Stevenson S., Barrett J. W., Gaebel S. M., Broekgaarden F. S., de Mink S. E., Szécsi D., Vinciguerra S., Mandel I., 2019, MNRAS, 490, 3740

  • If using the COMPAS model of (pulsational) pair instability supernova, please cite

    Stevenson S., Sampson M., Powell J., Vigna-Gómez A., Neijssel C. J., Szécsi D., Mandel I., 2019, ApJ, 882, 121

  • If evolving pulsar spins and magnetic fields with COMPAS, please cite

    Chattopadhyay D., Stevenson S., Hurley J. R., Rossi L. J., Flynn C., 2020, MNRAS

License

MIT

Highlighted papers that have made use of COMPAS are listed at https://compas.science/science.html ; see https://ui.adsabs.harvard.edu/public-libraries/gzRk1qpbRUy4cP2GydR36Q for a full ADS library

Owner

  • Name: COMPAS
  • Login: TeamCOMPAS
  • Kind: user
  • Location: Melbourne, AU

JOSS Publication

COMPAS: A rapid binary population synthesis suite
Published
January 21, 2022
Volume 7, Issue 69, Page 3838
Authors
Team Compas
The public COMPAS code is a product of work by the entire COMPAS collaboration over many years; we therefore kindly request that, in recognition of this team effort, the paper is cited as Team COMPAS - J. Riley et al.
Jeff Riley
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Poojan Agrawal
Centre for Astrophysics and Supercomputing, Swinburne University of Technology, Hawthorn, VIC 3122, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Jim W. Barrett
Institute of Gravitational Wave Astronomy and School of Physics and Astronomy, University of Birmingham, Birmingham, B15 2TT
Kristian N. k. Boyett
Department of Physics, University of Oxford, Denys Wilkinson Building, Keble Road, Oxford OX1 3RH, UK
Floor S. Broekgaarden
Center for Astrophysics |Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA
Debatri Chattopadhyay
School of Physics and Astronomy, Cardiff University, Cardiff, CF24 3AA, United Kingdom, Centre for Astrophysics and Supercomputing, Swinburne University of Technology, Hawthorn, VIC 3122, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Sebastian M. Gaebel
Max Planck Institute for Gravitational Physics (Albert Einstein Institute), Callinstrasse 38, D-30167 Hannover, Germany
Fabian Gittins
Mathematical Sciences and STAG Research Centre, University of Southampton, Southampton SO17 1BJ, UK
Ryosuke Hirai
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
George Howitt
School of Physics, University of Melbourne, Parkville, Victoria, 3010, Australia
Stephen Justham
Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands, School of Astronomy & Space Science, University of the Chinese Academy of Sciences, Beijing 100012, China, Max Planck Institute for Astrophysics, Karl-Schwarzschild-Str. 1, 85748 Garching, Germany
Lokesh Khandelwal
Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands
Floris Kummer
Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands
Mike Y. m. Lau
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Ilya Mandel
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia, Institute of Gravitational Wave Astronomy and School of Physics and Astronomy, University of Birmingham, Birmingham, B15 2TT
Selma E. de Mink
Max Planck Institute for Astrophysics, Karl-Schwarzschild-Str. 1, 85748 Garching, Germany, Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands, Center for Astrophysics |Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA
Coenraad Neijssel
Institute of Gravitational Wave Astronomy and School of Physics and Astronomy, University of Birmingham, Birmingham, B15 2TT, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Tim Riley
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Lieke van Son
Center for Astrophysics |Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA, Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands, Max Planck Institute for Astrophysics, Karl-Schwarzschild-Str. 1, 85748 Garching, Germany
Simon Stevenson
Centre for Astrophysics and Supercomputing, Swinburne University of Technology, Hawthorn, VIC 3122, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Alejandro Vigna-Gómez
DARK, Niels Bohr Institute, University of Copenhagen, Jagtvej 128, 2200, Copenhagen, Denmark, Niels Bohr International Academy, The Niels Bohr Institute, Blegdamsvej 17, 2100 Copenhagen, Denmark
Serena Vinciguerra
Anton Pannekoek Institute of Astronomy and GRAPPA, Science Park 904, University of Amsterdam, 1098XH Amsterdam, The Netherlands
Tom Wagg
Center for Astrophysics |Harvard & Smithsonian, 60 Garden St., Cambridge, MA 02138, USA, Max Planck Institute for Astrophysics, Karl-Schwarzschild-Str. 1, 85748 Garching, Germany
Reinhold Willcox
School of Physics and Astronomy, Monash University, Clayton, Victoria 3800, Australia, OzGrav, Australian Research Council Centre of Excellence for Gravitational Wave Discovery, Australia
Editor
Christina Hedges ORCID
Tags
C++ astronomy gravitational waves binary evolution

GitHub Events

Total
  • Issues event: 135
  • Watch event: 9
  • Delete event: 81
  • Member event: 4
  • Issue comment event: 574
  • Push event: 339
  • Pull request event: 199
  • Pull request review event: 206
  • Fork event: 11
  • Create event: 79
Last Year
  • Issues event: 135
  • Watch event: 9
  • Delete event: 81
  • Member event: 4
  • Issue comment event: 574
  • Push event: 339
  • Pull request event: 199
  • Pull request review event: 206
  • Fork event: 11
  • Create event: 79

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,613
  • Total Committers: 44
  • Avg Commits per committer: 59.386
  • Development Distribution Score (DDS): 0.79
Past Year
  • Commits: 570
  • Committers: 16
  • Avg Commits per committer: 35.625
  • Development Distribution Score (DDS): 0.749
Top Committers
Name Email Commits
Reinhold Willcox r****x@m****a 549
jeffriley j****y@m****u 502
Ilya Mandel i****l@m****u 272
ilyamandel i****l@g****m 224
Avi Vajpeyi a****i@g****m 223
Veome Kapil v****l@g****m 125
Mike Lau m****u@m****u 91
Lieke van Son a****n@g****m 75
Simon Stevenson s****n@g****m 71
Tom Wagg t****g@c****u 67
Adam Brcek b****m@g****m 67
FloorBroekgaarden f****n@c****u 61
Yuzhe Song y****g@s****u 43
Reinhold Willcox r****x@m****u 42
Alejandro Vigna-Gomez a****z@g****m 40
Jonathan Merritt j****t@M****l 32
Nicolas Rodriguez-Segovia n****a@a****u 23
Tom Reichardt t****t@s****u 13
Tim t****y@s****m 12
Isobel Romero-Shaw i****w@g****m 12
Manodeep Sinha m****p@g****m 8
Jonathan Merritt j****t@M****e 6
Lieke van Son a****n@c****u 6
jeffriley j****f@D****n 5
Debatri c****i@g****m 5
Eman Ali e****9@g****m 4
LiekeVanSon l****n@h****m 4
vkapil1 v****1@l****r 4
Tom Wagg t****g@g****m 3
Nicolas Rodriguez 6****o 3
and 14 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 163
  • Total pull requests: 326
  • Average time to close issues: 9 months
  • Average time to close pull requests: 16 days
  • Total issue authors: 26
  • Total pull request authors: 17
  • Average comments per issue: 2.78
  • Average comments per pull request: 2.26
  • Merged pull requests: 272
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 80
  • Pull requests: 204
  • Average time to close issues: 15 days
  • Average time to close pull requests: 3 days
  • Issue authors: 17
  • Pull request authors: 14
  • Average comments per issue: 1.81
  • Average comments per pull request: 2.37
  • Merged pull requests: 171
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ilyamandel (45)
  • reinhold-willcox (22)
  • SimonStevenson (20)
  • jeffriley (19)
  • dumbscholar (12)
  • avivajpeyi (9)
  • yuzhesong (5)
  • veome22 (4)
  • TomWagg (4)
  • LiekeVanSon (3)
  • avigna (2)
  • jmerritt1 (2)
  • FloorBroekgaarden (2)
  • lee0517-hub (2)
  • brcekadam (1)
Pull Request Authors
  • jeffriley (129)
  • ilyamandel (75)
  • avivajpeyi (28)
  • reinhold-willcox (27)
  • SimonStevenson (20)
  • veome22 (18)
  • brcekadam (13)
  • yuzhesong (6)
  • jmerritt1 (3)
  • TomReichardt (2)
  • melanie-santiago26 (2)
  • Adam-Boesky (1)
  • axfa (1)
  • dumbscholar (1)
  • TeamCOMPAS (1)
Top Labels
Issue Labels
bug (45) urgency_low (36) severity_minor (32) urgency_moderate (31) severity_moderate (30) enhancement (24) good first issue (16) documentation (14) urgency_high (9) severity_major (8) question (7) wontfix (6) code cleanup/optimisation (5) help wanted (4) invalid (3) post-processing (2) urgent (2) user_misunderstanding (2) test (1) CI/CD (1)
Pull Request Labels
bug (53) severity_minor (30) severity_moderate (29) urgency_low (28) urgency_moderate (27) enhancement (25) urgency_high (10) documentation (8) code cleanup/optimisation (5) severity_major (5)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
pypi.org: compas-python-utils

COMPAS Python Utilities

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15 Last month
Rankings
Dependent packages count: 9.9%
Average: 32.8%
Dependent repos count: 55.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • IPython *
  • PyYAML *
  • astropy >=4.0
  • h5py *
  • ipykernel *
  • latex *
  • linuxdoc ==20210324
  • matplotlib >=3.3.2
  • nbsphinx *
  • numpy >=1.16
  • numpydoc *
  • pandas *
  • scipy >=1.5.0
  • sphinx-argparse *
  • sphinx-math-dollar >=1.2
  • sphinx-tabs *
  • sphinx_rtd_theme ==0.5.1
  • sphinxcontrib.bibtex *
setup.py pypi
.github/workflows/compas-compile-ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/dockerhub-ci.yml actions
  • actions/checkout v2 composite
.github/workflows/latex-compile-ci.yml actions
  • actions/checkout v2 composite
  • dante-ev/latex-action latest composite
.github/workflows/precommit-checks.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pre-commit/action v2.0.3 composite
Dockerfile docker
  • ubuntu 18.04 build
.github/workflows/pr_artifact_url_commenter.yml actions
  • peter-evans/create-or-update-comment v3 composite
  • peter-evans/find-comment v2 composite
online-docs/requirements.in pypi
  • sphinx <7
  • sphinx_rtd_theme *
online-docs/requirements.txt pypi
  • readthedocs-sphinx-search ==0.1.1
  • sphinx ==7.0.1
  • sphinx_rtd_theme ==1.2.2