From d4c371b760153155d4739de3fbc3b2ad88438144 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Thu, 22 Jan 2026 10:13:57 -0800 Subject: [PATCH 1/5] updated default value listed in --maximum-evolution-time there is a minor type in the documentation and YAML file for --maximum-evolution-time the default YAML file says "maximum-evolution-time: 14021.28" (https://github.com/TeamCOMPAS/COMPAS/blob/dev/compas_python_utils/preprocessing/compasConfigDefault.yaml ) but the online documentation says: --maximum-evolution-time Maximum time to evolve binaries (Myr). Evolution of the binary will stop if this number is reached. Default = 13700.0 The correct value is 14031, which is the value that one obtains when you take the HUBBLE_TIME value from src/constants.h (and use the default definition from src/Options.cpp which defines maximum-evolution-time as: `m_MaxEvolutionTime > HUBBLE_TIME / SECONDS_IN_MYR`, which leads to 14031 Myr as the default (The 14021.28 Myr value comes from doing the same calculations but rounding values early on). More precisely, the calculation is: 1/ (67.8 * 1000.0 / (3.0* 10^(22))) seconds to Myr = 14031 Myr , with 67.8 from WMAP from the constant.h defaults. Again, not a big deal, just a rounding of the value/typo. So a very minor fix --- compas_python_utils/preprocessing/compasConfigDefault.yaml | 2 +- .../Program options/program-options-list-defaults.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/compas_python_utils/preprocessing/compasConfigDefault.yaml b/compas_python_utils/preprocessing/compasConfigDefault.yaml index 89ab35b98..1b50dcb9f 100644 --- a/compas_python_utils/preprocessing/compasConfigDefault.yaml +++ b/compas_python_utils/preprocessing/compasConfigDefault.yaml @@ -84,7 +84,7 @@ numericalChoices: # --hdf5-buffer-size: 1 # Default: 1 # --log-level: 0 # Default: 0 # --mass-change-fraction: 0.001000 # Default: 0.001000 # approximate desired fractional changes in stellar mass per timestep -# --maximum-evolution-time: 14021.28 # Default: 14021.28 # maximum physical time a system can be evolved [Myr] +# --maximum-evolution-time: 14031 # Default: 14031 (Hubble time) # maximum physical time a system can be evolved [Myr] # --maximum-number-timestep-iterations: 99999 # Default: 99999 # --number-of-systems: 10 # Default: 10 # number of systems per batch # --radial-change-fraction: 0.100000 # Default: 0.100000 # approximate desired fractional changes in stellar radius per timestep diff --git a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst index f58250522..1ec3af03a 100644 --- a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst +++ b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst @@ -939,7 +939,7 @@ Default = 10.0 **--maximum-evolution-time** |br| Maximum time to evolve binaries (Myr). Evolution of the binary will stop if this number is reached. |br| -Default = 13700.0 +Default = Hubble time (i.e., 14031 Myr) **--maximum-mass-donor-nandez-ivanova** |br| Maximum donor mass allowed for the revised common envelope formalism of Nandez & Ivanova (:math:`M_\odot`). |br| From d66549bbf4d9b7180284730d0ec21c18fc6f9745 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Mon, 16 Feb 2026 17:45:14 -0800 Subject: [PATCH 2/5] Update compasConfigDefault.yaml --- compas_python_utils/preprocessing/compasConfigDefault.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/compas_python_utils/preprocessing/compasConfigDefault.yaml b/compas_python_utils/preprocessing/compasConfigDefault.yaml index 1b50dcb9f..a4542a464 100644 --- a/compas_python_utils/preprocessing/compasConfigDefault.yaml +++ b/compas_python_utils/preprocessing/compasConfigDefault.yaml @@ -84,7 +84,7 @@ numericalChoices: # --hdf5-buffer-size: 1 # Default: 1 # --log-level: 0 # Default: 0 # --mass-change-fraction: 0.001000 # Default: 0.001000 # approximate desired fractional changes in stellar mass per timestep -# --maximum-evolution-time: 14031 # Default: 14031 (Hubble time) # maximum physical time a system can be evolved [Myr] +# --maximum-evolution-time: 13800 # Default: 13800 Myr # maximum physical time a system can be evolved [Myr] # --maximum-number-timestep-iterations: 99999 # Default: 99999 # --number-of-systems: 10 # Default: 10 # number of systems per batch # --radial-change-fraction: 0.100000 # Default: 0.100000 # approximate desired fractional changes in stellar radius per timestep From 922973eb2089ccb7b8276cd8dd363d46ceb8aac4 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Mon, 16 Feb 2026 17:49:04 -0800 Subject: [PATCH 3/5] updated to 13800 for simplicity --- .../Program options/program-options-list-defaults.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst index 1ec3af03a..32ebdbb7a 100644 --- a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst +++ b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst @@ -939,7 +939,7 @@ Default = 10.0 **--maximum-evolution-time** |br| Maximum time to evolve binaries (Myr). Evolution of the binary will stop if this number is reached. |br| -Default = Hubble time (i.e., 14031 Myr) +Default = 13800 (i.e., approximate age of the Universe cf. WMPA and Planck) **--maximum-mass-donor-nandez-ivanova** |br| Maximum donor mass allowed for the revised common envelope formalism of Nandez & Ivanova (:math:`M_\odot`). |br| From daadc128fe2e31c56c615d20d0fa28e38c5f2358 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Mon, 16 Feb 2026 18:08:16 -0800 Subject: [PATCH 4/5] updated text slightly to be above Default --- .../Program options/program-options-list-defaults.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst index 32ebdbb7a..c2fc7c6c3 100644 --- a/online-docs/pages/User guide/Program options/program-options-list-defaults.rst +++ b/online-docs/pages/User guide/Program options/program-options-list-defaults.rst @@ -939,7 +939,8 @@ Default = 10.0 **--maximum-evolution-time** |br| Maximum time to evolve binaries (Myr). Evolution of the binary will stop if this number is reached. |br| -Default = 13800 (i.e., approximate age of the Universe cf. WMPA and Planck) +Set to 13800 Myr as the approximate age of the Universe cf. WMPA and Planck. |br| +Default = 13800 **--maximum-mass-donor-nandez-ivanova** |br| Maximum donor mass allowed for the revised common envelope formalism of Nandez & Ivanova (:math:`M_\odot`). |br| From 17508d37cfc2da8481cb14c0763679a11d5abce0 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Mon, 16 Feb 2026 18:30:20 -0800 Subject: [PATCH 5/5] updated also in Options.cpp to change the default in the cpp code accordingly --- src/Options.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Options.cpp b/src/Options.cpp index ec62db46c..4bdb884c6 100644 --- a/src/Options.cpp +++ b/src/Options.cpp @@ -241,7 +241,7 @@ void Options::OptionValues::Initialise() { m_RandomSeed = 0; // Specify how long to evolve for - m_MaxEvolutionTime = HUBBLE_TIME / SECONDS_IN_MYR; //13700.0; + m_MaxEvolutionTime = 13800; // in Myr; approximate age of the Universe cf. WMPA and Planck. ; m_MaxNumberOfTimestepIterations = 99999; m_TimestepsFileName = ""; @@ -2618,7 +2618,7 @@ std::string Options::OptionValues::CheckAndSetOptions() { COMPLAIN_IF(m_MassRatioDistributionMax <= m_MassRatioDistributionMin, "Maximum mass ratio (--mass-ratio-max) must be > Minimum mass ratio (--mass-ratio-min)"); COMPLAIN_IF(m_MaxEvolutionTime <= 0.0, "Maximum evolution time in Myr (--maxEvolutionTime) must be > 0"); - COMPLAIN_IF(m_MaxEvolutionTime > HUBBLE_TIME / SECONDS_IN_MYR, "Maximum evolution time in Myr (--maxEvolutionTime) must be <= " + std::to_string(HUBBLE_TIME / SECONDS_IN_MYR) + " Myr"); + COMPLAIN_IF(m_MaxEvolutionTime > 13800, "Maximum evolution time in Myr (--maxEvolutionTime) must be <= " + std::to_string(13800) + " Myr"); COMPLAIN_IF(m_Metallicity < MINIMUM_METALLICITY || m_Metallicity > MAXIMUM_METALLICITY, "Metallicity (--metallicity) should be absolute metallicity and must be between " + std::to_string(MINIMUM_METALLICITY) + " and " + std::to_string(MAXIMUM_METALLICITY)); COMPLAIN_IF(m_MetallicityDistributionMin < MINIMUM_METALLICITY || m_MetallicityDistributionMin > MAXIMUM_METALLICITY, "Minimum metallicity (--metallicity-min) must be between " + std::to_string(MINIMUM_METALLICITY) + " and " + std::to_string(MAXIMUM_METALLICITY));