From d4c371b760153155d4739de3fbc3b2ad88438144 Mon Sep 17 00:00:00 2001 From: FloorBroekgaarden Date: Thu, 22 Jan 2026 10:13:57 -0800 Subject: [PATCH] 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|