Skip to content

Commit

Permalink
cleaned up the changelog and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
veome22 committed Apr 17, 2024
1 parent bab252b commit af1b544
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -340,12 +340,6 @@ Following is an alphabetical list of stellar properties available for inclusion
* - Header Strings:
- Mass_Core@\ CO, Mass_Core@CO(1), Mass_Core@CO(2), Mass_Core@CO(SN), Mass_Core@CO(CP)

.. flat-table::
:widths: 25 75 1 1
:header-rows: 0
:class: aligned-text



.. _stellar-props-D:

Expand All @@ -367,10 +361,6 @@ Following is an alphabetical list of stellar properties available for inclusion
* - Header Strings:
- Drawn_Kick_Magnitude, Drawn_Kick_Magnitude(1), Drawn_Kick_Magnitude(2), Drawn_Kick_Magnitude(SN), Drawn_Kick_Magnitude(CP)

.. flat-table::
:widths: 25 75 1 1
:header-rows: 0
:class: aligned-text

* - :cspan:`2` **DOMINANT_MASS_LOSS_RATE**
-
Expand Down
1 change: 1 addition & 0 deletions online-docs/pages/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Following is a brief list of important updates to the COMPAS code. A complete r

* Added 'realistic' tides option, which implements dynamical tides.
* Functionality enabled with new option ``--tides-prescription KAPIL2024`` (default is ``NONE``).
* Removed old option ``--enable-tides``, which can now be enabled by setting ``--tides-prescription PERFECT``.
* Added new function CalculateCoreRadius().


Expand Down
2 changes: 1 addition & 1 deletion src/changelog.h
Original file line number Diff line number Diff line change
Expand Up @@ -1120,9 +1120,9 @@
//
// 02.44.00 VK - Apr 04, 2024 - Enhancement:
// - Added dynamical tides to binary evolution. Functionality enabled by setting the new option `--tides-prescription` to the value `KAPIL2024` (default is `NONE`)
// - Removed old option `--enable-tides`, which can now be enabled by setting `--tides-prescription PERFECT`.
// - Dynamcial tides implementation follows Zahn, 1977, Eq. (5.5) , with the value of E_2 coming from Kushnir et al., 2017, Eq. (8).
// - Secular evolution under the effect of tides follows Zahn, 1977, Eqs. (3.6) to (3.8)
// - Moved previous tides implementation under `PERFECT` prescription for `--tides-prescription`
// - Added function CalculateCoreRadius(). Currently returns the same value as CalculateRemnantRadius() for Giant Branch stars, returns 0.0 otherwise

const std::string VERSION_STRING = "02.44.00";
Expand Down

0 comments on commit af1b544

Please sign in to comment.