Skip to content

Commit 02029e4

Browse files
veome22veome22
committed
Merged dev
2 parents 8ce462c + fccdf41 commit 02029e4

31 files changed

+766
-264
lines changed

‎compas_python_utils/preprocessing/compasConfigDefault.yaml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
##~!!~## COMPAS option values
2-
##~!!~## File Created Fri May 16 00:48:34 2025 by COMPAS v03.19.00
2+
##~!!~## File Created Thu May 22 20:41:26 2025 by COMPAS v03.19.00
33
##~!!~##
44
##~!!~## The default COMPAS YAML file (``compasConfigDefault.yaml``), as distributed, has
55
##~!!~## all COMPAS option entries commented so that the COMPAS default value for the
@@ -76,17 +76,20 @@ numericalChoices:
7676
# --logfile-pulsar-evolution-record-types: -1 # Default: -1
7777
# --logfile-rlof-parameters-record-types: -1 # Default: -1
7878
# --logfile-supernovae-record-types: -1 # Default: -1
79+
# --logfile-system-snapshot-log-record-types: -1 # Default: -1
7980
# --logfile-system-parameters-record-types: -1 # Default: -1
8081
# --grid-lines-to-process: 9223372036854775807 # Default: 9223372036854775807
8182
# --grid-start-line: 0 # Default: 0
8283
# --hdf5-chunk-size: 100000 # Default: 100000
8384
# --hdf5-buffer-size: 1 # Default: 1
8485
# --log-level: 0 # Default: 0
8586
# --mass-change-fraction: 0.001000 # Default: 0.001000 # approximate desired fractional changes in stellar mass per timestep
86-
# --maximum-evolution-time: 13700.00 # Default: 13700.00 # maximum physical time a system can be evolved [Myr]
87+
# --maximum-evolution-time: 14021.28 # Default: 14021.28 # maximum physical time a system can be evolved [Myr]
8788
# --maximum-number-timestep-iterations: 99999 # Default: 99999
8889
# --number-of-systems: 10 # Default: 10 # number of systems per batch
8990
# --radial-change-fraction: 0.100000 # Default: 0.100000 # approximate desired fractional changes in stellar radius per timestep
91+
# --system-snapshot-age-thresholds: '{ }' # Default: '' # age thresholds for the system snapshot log
92+
# --system-snapshot-time-thresholds: '{ }' # Default: '' # time thresholds for the system snapshot log
9093
# --timestep-multiplier: 1.000000 # Default: 1.000000 # optional multiplier relative to default time step duration
9194
# --timestep-multipliers: '{ }' # Default: '' # optional phase-dependent multipliers relative to default time step duration
9295

@@ -296,6 +299,7 @@ stringChoices:
296299
# --logfile-rlof-parameters: 'BSE_RLOF' # Default: 'BSE_RLOF'
297300
# --logfile-supernovae: 'BSE_Supernovae' # Default: 'BSE_Supernovae'
298301
# --logfile-switch-log: 'BSE_Switch_Log' # Default: 'BSE_Switch_Log'
302+
# --logfile-system-snapshot-log: 'BSE_System_Snapshot_Log' # Default: 'BSE_System_Snapshot_Log'
299303
# --logfile-system-parameters: 'BSE_System_Parameters' # Default: 'BSE_System_Parameters'
300304
# --output-path: '.' # Default: '.'
301305

‎online-docs/README.rst‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,12 @@ In the repository root directory:
3737
3838
View results in 'docs/online-docs/_build/html/index.html'
3939

40-
Make sure there arnt any broken links! See the build logs:
40+
Make sure there aren't any broken links! See the build logs:
4141

42-
```
43-
(pages/User guide/docker: line 22) ok https://stackoverflow.com/questions/23735149/what-is-the-difference-between-a-docker-image-and-a-container
44-
(pages/Developer guide/Developer build/docker-developer: line 23) ok https://www.atlassian.com/continuous-delivery/principles/continuous-integration-vs-delivery-vs-deployment
45-
(pages/User guide/Running COMPAS/running-via-docker: line 41) broken https://stackoverflow.com/questions/23735149/what-is-the-difference-between-a-docker-image-and-a-container#:~:text=An%20instance%20of%20an%20image,of%20layers%20as%20you%20describe.&text=You%20can%20see%20all%20your,an%20image%20is%20a%20container - Anchor '%3A~%3Atext%3DAn%20instance%20of%20an%20image%2Cof%20layers%20as%20you%20describe.%26text%3DYou%20can%20see%20all%20your%2Can%20image%20is%20a%20container' not found
46-
(pages/User guide/docker: line 49) ok https://www.docker.com/
47-
48-
```
42+
.. (pages/User guide/docker: line 22) ok https://stackoverflow.com/questions/23735149/what-is-the-difference-between-a-docker-image-and-a-container
43+
.. (pages/Developer guide/Developer build/docker-developer: line 23) ok https://www.atlassian.com/continuous-delivery/principles/continuous-integration-vs-delivery-vs-deployment
44+
.. (pages/User guide/Running COMPAS/running-via-docker: line 41) broken https://stackoverflow.com/questions/23735149/what-is-the-difference-between-a-docker-image-and-a-container#:~:text=An%20instance%20of%20an%20image,of%20layers%20as%20you%20describe.&text=You%20can%20see%20all%20your,an%20image%20is%20a%20container - Anchor '%3A~%3Atext%3DAn%20instance%20of%20an%20image%2Cof%20layers%20as%20you%20describe.%26text%3DYou%20can%20see%20all%20your%2Can%20image%20is%20a%20container' not found
45+
.. (pages/User guide/docker: line 49) ok https://www.docker.com/
4946
5047
5148
Pushing the changes online

‎online-docs/pages/Developer guide/Services/Program options/services-program-options.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Adding new program options
3030

3131
To add a new program option, take the following steps (these are duplicated at the top of the ``Options.cpp`` source file):
3232

33-
1. Decide on a string for the option - this is the string the user will use on the commandline or in the grid file (e.g. "random-seed"). The convention is hyphenated lower case. Try to be consistent with existing option names. For example, if you are adding a new prescription for something, make sure the option name ends with "-prescription", or if you are adding a new distribution for something, make sure the option name ends with "-distribution". */
33+
1. Decide on a string for the option - this is the string the user will use on the commandline or in the grid file (e.g. "random-seed"). The convention is hyphenated lower case. Try to be consistent with existing option names. For example, if you are adding a new prescription for something, make sure the option name ends with "-prescription", or if you are adding a new distribution for something, make sure the option name ends with "-distribution".
3434

3535
2. Decide on a class member variable name for the option (e.g. m_RandomSeed).
3636

online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-BSE-detailed.rst renamed to online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-BSE-detailed-output.rst

File renamed without changes.

‎online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-BSE-system-snapshot.rst‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
BSE system snapshot
2+
===================
3+
4+
Default record definition for the BSE System Snapshot log file::
5+
6+
const ANY_PROPERTY_VECTOR BSE_SYSTEM_SNAPSHOT_LOG_REC = {
7+
BINARY_PROPERTY::RANDOM_SEED,
8+
BINARY_PROPERTY::DT,
9+
BINARY_PROPERTY::TIME,
10+
BINARY_PROPERTY::UNBOUND,
11+
BINARY_PROPERTY::SEMI_MAJOR_AXIS_RSOL,
12+
BINARY_PROPERTY::ECCENTRICITY,
13+
STAR_1_PROPERTY::MZAMS,
14+
STAR_2_PROPERTY::MZAMS,
15+
STAR_1_PROPERTY::MASS_0,
16+
STAR_2_PROPERTY::MASS_0,
17+
STAR_1_PROPERTY::MASS,
18+
STAR_2_PROPERTY::MASS,
19+
STAR_1_PROPERTY::ENV_MASS,
20+
STAR_2_PROPERTY::ENV_MASS,
21+
STAR_1_PROPERTY::CORE_MASS,
22+
STAR_2_PROPERTY::CORE_MASS,
23+
STAR_1_PROPERTY::HE_CORE_MASS,
24+
STAR_2_PROPERTY::HE_CORE_MASS,
25+
STAR_1_PROPERTY::CO_CORE_MASS,
26+
STAR_2_PROPERTY::CO_CORE_MASS,
27+
STAR_1_PROPERTY::RADIUS,
28+
STAR_2_PROPERTY::RADIUS,
29+
BINARY_PROPERTY::ROCHE_LOBE_RADIUS_1,
30+
BINARY_PROPERTY::ROCHE_LOBE_RADIUS_2,
31+
STAR_1_PROPERTY::OMEGA,
32+
STAR_2_PROPERTY::OMEGA,
33+
STAR_1_PROPERTY::OMEGA_BREAK,
34+
STAR_2_PROPERTY::OMEGA_BREAK,
35+
STAR_1_PROPERTY::INITIAL_STELLAR_TYPE,
36+
STAR_2_PROPERTY::INITIAL_STELLAR_TYPE,
37+
STAR_1_PROPERTY::STELLAR_TYPE,
38+
STAR_2_PROPERTY::STELLAR_TYPE,
39+
STAR_1_PROPERTY::AGE,
40+
STAR_2_PROPERTY::AGE,
41+
STAR_1_PROPERTY::LUMINOSITY,
42+
STAR_2_PROPERTY::LUMINOSITY,
43+
STAR_1_PROPERTY::TEMPERATURE,
44+
STAR_2_PROPERTY::TEMPERATURE,
45+
STAR_1_PROPERTY::ANGULAR_MOMENTUM,
46+
STAR_2_PROPERTY::ANGULAR_MOMENTUM,
47+
STAR_1_PROPERTY::DYNAMICAL_TIMESCALE,
48+
STAR_2_PROPERTY::DYNAMICAL_TIMESCALE,
49+
STAR_1_PROPERTY::THERMAL_TIMESCALE,
50+
STAR_2_PROPERTY::THERMAL_TIMESCALE,
51+
STAR_1_PROPERTY::NUCLEAR_TIMESCALE,
52+
STAR_2_PROPERTY::NUCLEAR_TIMESCALE,
53+
STAR_1_PROPERTY::ZETA_SOBERMAN,
54+
STAR_2_PROPERTY::ZETA_SOBERMAN,
55+
STAR_1_PROPERTY::ZETA_SOBERMAN_HE,
56+
STAR_2_PROPERTY::ZETA_SOBERMAN_HE,
57+
STAR_1_PROPERTY::ZETA_HURLEY,
58+
STAR_2_PROPERTY::ZETA_HURLEY,
59+
STAR_1_PROPERTY::ZETA_HURLEY_HE,
60+
STAR_2_PROPERTY::ZETA_HURLEY_HE,
61+
STAR_1_PROPERTY::MASS_LOSS_DIFF,
62+
STAR_2_PROPERTY::MASS_LOSS_DIFF,
63+
STAR_1_PROPERTY::DOMINANT_MASS_LOSS_RATE,
64+
STAR_2_PROPERTY::DOMINANT_MASS_LOSS_RATE,
65+
STAR_1_PROPERTY::MASS_TRANSFER_DIFF,
66+
STAR_2_PROPERTY::MASS_TRANSFER_DIFF,
67+
BINARY_PROPERTY::TOTAL_ANGULAR_MOMENTUM,
68+
BINARY_PROPERTY::TOTAL_ENERGY,
69+
STAR_1_PROPERTY::METALLICITY,
70+
STAR_2_PROPERTY::METALLICITY,
71+
BINARY_PROPERTY::MASS_TRANSFER_TRACKER_HISTORY,
72+
STAR_1_PROPERTY::PULSAR_MAGNETIC_FIELD,
73+
STAR_2_PROPERTY::PULSAR_MAGNETIC_FIELD,
74+
STAR_1_PROPERTY::PULSAR_SPIN_PERIOD,
75+
STAR_2_PROPERTY::PULSAR_SPIN_PERIOD,
76+
STAR_1_PROPERTY::PULSAR_SPIN_DOWN_RATE,
77+
STAR_2_PROPERTY::PULSAR_SPIN_DOWN_RATE,
78+
STAR_1_PROPERTY::PULSAR_BIRTH_PERIOD,
79+
STAR_2_PROPERTY::PULSAR_BIRTH_PERIOD,
80+
STAR_1_PROPERTY::PULSAR_BIRTH_SPIN_DOWN_RATE,
81+
STAR_2_PROPERTY::PULSAR_BIRTH_SPIN_DOWN_RATE,
82+
STAR_1_PROPERTY::RADIAL_EXPANSION_TIMESCALE,
83+
STAR_2_PROPERTY::RADIAL_EXPANSION_TIMESCALE,
84+
BINARY_PROPERTY::RLOF_MASS_LOSS_RATE,
85+
BINARY_PROPERTY::RLOF_MASS_TRANSFER_TIMESCALE,
86+
BINARY_PROPERTY::RLOF_ACCRETION_EFFICIENCY
87+
};
88+

online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-SSE-detailed.rst renamed to online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-SSE-detailed-output.rst

File renamed without changes.

‎online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications-SSE-system-snapshot.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
SSE system snapshot
2+
===================
3+
4+
Default record definition for the SSE System Snapshot log file::
5+
6+
const ANY_PROPERTY_VECTOR SSE_SYSTEM_SNAPSHOT_LOG_REC = {
7+
STAR_PROPERTY::AGE,
8+
STAR_PROPERTY::DT,
9+
STAR_PROPERTY::TIME,
10+
STAR_PROPERTY::STELLAR_TYPE,
11+
STAR_PROPERTY::METALLICITY,
12+
STAR_PROPERTY::MASS_0,
13+
STAR_PROPERTY::MASS,
14+
STAR_PROPERTY::RADIUS,
15+
STAR_PROPERTY::RZAMS,
16+
STAR_PROPERTY::LUMINOSITY,
17+
STAR_PROPERTY::TEMPERATURE,
18+
STAR_PROPERTY::CORE_MASS,
19+
STAR_PROPERTY::CO_CORE_MASS,
20+
STAR_PROPERTY::HE_CORE_MASS,
21+
STAR_PROPERTY::MDOT,
22+
STAR_PROPERTY::DOMINANT_MASS_LOSS_RATE,
23+
STAR_PROPERTY::TIMESCALE_MS
24+
};
25+

‎online-docs/pages/User guide/COMPAS output/standard-logfiles-default-record-specifications.rst‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,26 @@ For Single Star Evolution (SSE):
99
.. toctree::
1010
:maxdepth: 1
1111

12-
standard-logfiles-default-record-specifications-SSE-detailed
13-
standard-logfiles-default-record-specifications-SSE-pulsars
12+
standard-logfiles-default-record-specifications-SSE-system-snapshot
13+
standard-logfiles-default-record-specifications-SSE-sysparms
14+
standard-logfiles-default-record-specifications-SSE-detailed-output
1415
standard-logfiles-default-record-specifications-SSE-supernovae
16+
standard-logfiles-default-record-specifications-SSE-pulsars
1517
standard-logfiles-default-record-specifications-SSE-switchlog
16-
standard-logfiles-default-record-specifications-SSE-sysparms
1718

1819
For Binary Star Evolution (BSE):
1920

2021
.. toctree::
2122
:maxdepth: 1
2223

24+
standard-logfiles-default-record-specifications-BSE-system-snapshot
2325
standard-logfiles-default-record-specifications-BSE-sysparms
24-
standard-logfiles-default-record-specifications-BSE-detailed
26+
standard-logfiles-default-record-specifications-BSE-detailed-output
2527
standard-logfiles-default-record-specifications-BSE-supernovae
2628
standard-logfiles-default-record-specifications-BSE-dco
2729
standard-logfiles-default-record-specifications-BSE-ce
2830
standard-logfiles-default-record-specifications-BSE-pulsars
2931
standard-logfiles-default-record-specifications-BSE-rlof
3032
standard-logfiles-default-record-specifications-BSE-switchlog
33+
34+

‎online-docs/pages/User guide/COMPAS output/standard-logfiles-record-specification-stellar.rst‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@ Following is an alphabetical list of stellar properties available for inclusion
9797
* - COMPAS variable:
9898
-
9999
* - Description:
100-
- Absolute value of the binding energy of the convective portion of the envelope, via the :cite:`Picker2024` formalism, used for calculating post-CE separation in the 2-stage formalism
101-
(erg).
100+
- Absolute value of the binding energy of the convective portion of the envelope, via the :cite:`Picker2024` formalism, used for calculating post-CE separation in the 2-stage formalism (erg).
102101
* - Header Strings:
103102
- BE_ConvectiveEnvelope
104103

@@ -308,11 +307,6 @@ Following is an alphabetical list of stellar properties available for inclusion
308307
* - Header String:
309308
- ComponentSpeed
310309

311-
.. flat-table::
312-
:widths: 25 75 1 1
313-
:header-rows: 0
314-
:class: aligned-text
315-
316310
.. flat-table::
317311
:widths: 25 75 1 1
318312
:header-rows: 0

‎online-docs/pages/User guide/COMPAS output/standard-logfiles-record-specification.rst‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,20 @@ Log file definitions file specification
4040

4141
<rec_spec> ::= <rec_name> <op> "{" { [ <props_list> ] } "}" <spec_delim>
4242

43-
<rec_name> ::= "SSE_SYSPARMS_REC" | # SSE only
44-
"SSE_DETAILED_REC" | # SSE only
45-
"SSE_SNE_REC" | # SSE only
46-
"SSE_SWITCH_REC" | # SSE only
47-
"BSE_SYSPARMS_REC" | # BSE only
48-
"BSE_SWITCH_REC" | # BSE only
49-
"BSE_DCO_REC" | # BSE only
50-
"BSE_SNE_REC" | # BSE only
51-
"BSE_CEE_REC" | # BSE only
52-
"BSE_PULSARS_REC" | # BSE only
53-
"BSE_RLOF_REC" | # BSE only
54-
"BSE_DETAILED_REC" | # BSE only
43+
<rec_name> ::= "SSE_SYSPARMS_REC" | # SSE only
44+
"SSE_DETAILED_REC" | # SSE only
45+
"SSE_SYS_SNAPSHOT_REC" | # SSE only
46+
"SSE_SNE_REC" | # SSE only
47+
"SSE_SWITCH_REC" | # SSE only
48+
"BSE_SYSPARMS_REC" | # BSE only
49+
"BSE_SWITCH_REC" | # BSE only
50+
"BSE_DCO_REC" | # BSE only
51+
"BSE_SNE_REC" | # BSE only
52+
"BSE_CEE_REC" | # BSE only
53+
"BSE_PULSARS_REC" | # BSE only
54+
"BSE_RLOF_REC" | # BSE only
55+
"BSE_DETAILED_REC" | # BSE only
56+
"BSE_SYS_SNAPSHOT_REC" | # BSE only
5557
5658
<op> ::= "=" | "+=" | "-="
5759

0 commit comments

Comments
 (0)