Merge remote-tracking branch 'origin/dev' into tides_pseudo_sync

Author: veome22

README.md

@@ -16,34 +16,55 @@ https://compas.science/docs
 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.
 
 ## 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](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:
-
-@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}},
+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 papers 
+https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R
+and
+https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T .
+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 papers are cited as “Team COMPAS: J. Riley et al. (2021)” and "Team COMPAS: I. Mandel et al. (2025). Example bibtex codes are:
+
+@ARTICLE{compas2021,
+       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},
         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},
+     keywords = {1622, 154, 1108, 162},
          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}
 }
 
+@ARTICLE{compas2025,
+       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},
+        title = "{Rapid Stellar and Binary Population Synthesis with COMPAS: Methods Paper II}",
+      journal = {\apjs},
+     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},
+         year = 2025,
+        month = sep,
+       volume = {280},
+       number = {1},
+          eid = {43},
+        pages = {43},
+          doi = {10.3847/1538-4365/adf8d0},
+archivePrefix = {arXiv},
+       eprint = {2506.02316},
+ primaryClass = {astro-ph.SR},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T},
+      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]{}} }
+##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:
+##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}
+##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}
 
 
 

compas_python_utils/preprocessing/compasConfigDefault.yaml

@@ -1,5 +1,5 @@
 ##~!!~## COMPAS option values
-##~!!~## File Created Tue Sep  2 22:42:52 2025 by COMPAS v03.26.00
+##~!!~## File Created Mon Oct 27 18:34:22 2025 by COMPAS v03.27.01
 ##~!!~##
 ##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
 ##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -29,7 +29,7 @@ booleanChoices:
 #    --enhance-CHE-lifetimes-luminosities: True                            # Default: True
 #    --expel-convective-envelope-above-luminosity-threshold: False         # Default: False
 #    --natal-kick-for-PPISN: False                                         # Default: False
-#    --scale-CHE-mass-loss-with-surface-helium-abundance: True             # Default: True
+#    --scale-mass-loss-with-surface-helium-abundance: True                 # Default: True
 
     ### BINARY PROPERTIES
 #    --allow-touching-at-birth: False                                      # Default: False                                                                                                                                                                            # record binaries that have stars touching at birth in output files
@@ -57,6 +57,7 @@ booleanChoices:
 #    --allow-non-stripped-ECSN: False                                      # Default: False
 #    --pair-instability-supernovae: True                                   # Default: True
 #    --pulsational-pair-instability: True                                  # Default: True
+#    --USSN-kicks-override-mandel-muller: False                            # Default: False
 
     ### PULSAR PARAMETERS
 #    --evolve-pulsars: False                                               # Default: False
@@ -243,7 +244,7 @@ stringChoices:
 #    --envelope-state-prescription: 'LEGACY'                               # Default: 'LEGACY'                      # Options: ['CONVECTIVE_MASS_FRACTION','FIXED_TEMPERATURE','HURLEY','LEGACY']
 #    --initial-mass-function: 'KROUPA'                                     # Default: 'KROUPA'                      # Options: ['KROUPA','UNIFORM','POWERLAW','SALPETER']
 #    --LBV-mass-loss-prescription: 'HURLEY_ADD'                            # Default: 'HURLEY_ADD'                  # Options: ['BELCZYNSKI','HURLEY','HURLEY_ADD','ZERO']
-#    --main-sequence-core-mass-prescription: 'MANDEL'                      # Default: 'MANDEL'                      # Options: ['BRCEK','MANDEL','ZERO']
+#    --main-sequence-core-mass-prescription: 'MANDEL'                      # Default: 'MANDEL'                      # Options: ['BRCEK','MANDEL','HURLEY']
 #    --mass-loss-prescription: 'MERRITT2025'                               # Default: 'MERRITT2025'                 # Options: ['MERRITT2025','BELCZYNSKI2010','HURLEY','ZERO']
 #    --OB-mass-loss-prescription: 'VINK2021'                               # Default: 'VINK2021'                    # Options: ['KRTICKA2018','BJORKLUND2022','VINK2021','VINK2001','ZERO']
 #    --RSG-mass-loss-prescription: 'DECIN2023'                             # Default: 'DECIN2023'                   # Options: ['NJ90','KEE2021','YANG2023','DECIN2023','BEASOR2020','VINKSABHAHIT2023','ZERO']

online-docs/COMPAS-2021methodsPaper.bib

@@ -1,25 +1,15 @@
-@ This formats the citation for the COMPAS Methods Paper in our preferred style
-@ The following PREAMBLE entry must appear at the top of the bibtex file
-
-@PREAMBLE{ {\providecommand{\noopsort}[1]{}} }
-
-@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}
-}
-
-
+@ARTICLE{COMPAS:2021,
+       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},
+        title = "{Rapid Stellar and Binary Population Synthesis with COMPAS}",
+      journal = {\apjs},
+     keywords = {1622, 154, 1108, 162},
+         year = 2022,
+        month = feb,
+       volume = {258},
+       number = {2},
+          eid = {34},
+        pages = {34},
+          doi = {10.3847/1538-4365/ac416c},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2022ApJS..258...34R},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

online-docs/COMPAS-2025methodsPaper.bib

@@ -1,16 +1,18 @@
 @ARTICLE{COMPAS:2025,
        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},
-        title = "{Rapid stellar and binary population synthesis with COMPAS: methods paper II}",
-      journal = {arXiv e-prints},
-     keywords = {Solar and Stellar Astrophysics, High Energy Astrophysical Phenomena, Instrumentation and Methods for Astrophysics},
+        title = "{Rapid Stellar and Binary Population Synthesis with COMPAS: Methods Paper II}",
+      journal = {\apjs},
+     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},
          year = 2025,
-        month = jun,
-          eid = {arXiv:2506.02316},
-        pages = {arXiv:2506.02316},
-          doi = {10.48550/arXiv.2506.02316},
+        month = sep,
+       volume = {280},
+       number = {1},
+          eid = {43},
+        pages = {43},
+          doi = {10.3847/1538-4365/adf8d0},
 archivePrefix = {arXiv},
        eprint = {2506.02316},
  primaryClass = {astro-ph.SR},
-       adsurl = {https://ui.adsabs.harvard.edu/abs/2025arXiv250602316M},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2025ApJS..280...43T},
       adsnote = {Provided by the SAO/NASA Astrophysics Data System}
 }

online-docs/pages/User guide/Program options/program-options-list-defaults.rst

@@ -812,8 +812,8 @@ Default = 4.2
 
 **--main-sequence-core-mass-prescription** |br|
 Main sequence core mass prescription. |br|
-Options: {ZERO, MANDEL, BRCEK} |br|
-``ZERO``   : No core mass treatment, set to zero |br|
+Options: {HURLEY, MANDEL, BRCEK} |br|
+``HURLEY`` : Treatment from Hurley et al. (2000), in which MS stars do not have a distinct core and core evolution is not tracked |br|
 ``MANDEL`` : The core following case A mass transfer is set equal to the expected core mass of a newly formed HG star with mass equal to that of the donor, scaled by the fraction of the donor's MS lifetime at mass transfer |br|
 ``BRCEK``  : Core mass according to Shikauchi et al. (2024) with added rejuvenation of MS accretors and updated stellar tracks |br|
 Default = MANDEL
@@ -1319,9 +1319,9 @@ Default = DECIN2023 |br|
 
 :ref:`Back to Top <options-props-top>`
 
-**--scale-CHE-mass-loss-with-surface-helium-abundance** |br|
-Scale mass loss for chemically homogeneously evolving (CHE) stars with the surface helium abundance. 
-Transition from OB to WR mass loss towards the end of the main sequence.
+**--scale-mass-loss-with-surface-helium-abundance** |br|
+Scale mass loss for main sequence, including chemically homogeneously evolving (CHE), stars with the surface helium abundance. 
+Transition from OB/VMS to WR mass loss towards the end of the main sequence.
 Default = TRUE
 
 **--scale-terminal-wind-velocity-with-metallicity-power** |br|
@@ -1431,6 +1431,10 @@ This option is primarily intended for debugging/testing of convergence issues ra
 Enable mass transfer. |br|
 Default = TRUE
 
+**--USSN-kicks-override-mandel-muller** |br|
+Use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe. |br|
+Default = FALSE
+
 .. _options-props-V:
 
 :ref:`Back to Top <options-props-top>`
@@ -1531,7 +1535,7 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 
 --check-photon-tiring-limit, --cool-wind-mass-loss-multiplier, --luminous-blue-variable-prescription, --LBV-mass-loss-prescription
 --luminous-blue-variable-multiplier, --main-sequence-core-mass-prescription, --mass-loss-prescription, --overall-wind-mass-loss-multiplier, --wolf-rayet-multiplier, 
---expel-convective-envelope-above-luminosity-threshold, --luminosity-to-mass-threshold,
+--expel-convective-envelope-above-luminosity-threshold, --luminosity-to-mass-threshold, --scale--mass-loss-with-surface-helium-abundance
 --OB-mass-loss, --OB-mass-loss-prescription, --RSG-mass-loss, --RSG-mass-loss-prescription, --VMS-mass-loss, --vms-mass-loss-prescription, --WR-mass-loss, --WR-mass-loss-prescription
 
 --chemically-homogeneous-evolution, --chemically-homogeneous-evolution-mode
@@ -1583,8 +1587,8 @@ Go to :ref:`the top of this page <options-props-top>` for the full alphabetical
 --kick-magnitude-distribution, --kick-magnitude-sigma-CCSN-BH, --kick-magnitude-sigma-CCSN-NS, --kick-magnitude-sigma-ECSN, --kick-magnitude-sigma-USSN, 
 --black-hole-kicks, --black-hole-kicks-mode, --fix-dimensionless-kick-magnitude, --kick-magnitude, --kick-magnitude-1, --kick-magnitude-2, --kick-magnitude-min, --kick-magnitude-max, 
 --kick-magnitude-random, --kick-magnitude-random-1, --kick-magnitude-random-2, --kick-scaling-factor, -muller-mandel-kick-multiplier-BH, 
---muller-mandel-kick-multiplier-NS, --muller-mandel-sigma-kick-BH, --muller-mandel-sigma-kick-NS, --kick-direction, 
---kick-direction-distribution, --kick-direction-power, --kick-mean-anomaly-1, --kick-mean-anomaly-2, --kick-phi-1, --kick-phi-2, --kick-theta-1, --kick-theta-2
+--muller-mandel-kick-multiplier-NS, --muller-mandel-sigma-kick-BH, --muller-mandel-sigma-kick-NS, --USSN-kicks-override-mandel-muller, 
+--kick-direction, --kick-direction-distribution, --kick-direction-power, --kick-mean-anomaly-1, --kick-mean-anomaly-2, --kick-phi-1, --kick-phi-2, --kick-theta-1, --kick-theta-2
 
 :ref:`Back to Top <options-props-top>`
 

online-docs/pages/whats-new.rst

@@ -3,6 +3,11 @@ What's new
 
 Following is a brief list of important updates to the COMPAS code.  A complete record of changes can be found in the file ``changelog.h``.
 
+**03.26.02 October 27, 2025**
+
+* Added option --USSN-kicks-override-mandel-muller ; if set to true, use user-defined USSN kicks (as a fixed value) in lieu of the Mandel & Muller kick prescription for USSNe
+* Replaced --scale-CHE-mass-loss-with-surface-helium-abundance with the more general --scale-mass-loss-with-surface-helium-abundance (applies to all MS stars, not just CHE stars)
+
 **03.26.00 September 2, 2025**
 
 * Added HAMSTARS mass transfer efficiency prescription