fixed imports, option description code works again

binarycpython/utils/functions.py

@@ -1037,8 +1037,11 @@ def make_build_text() -> str:
     Returns:
         string containing information about the build and the git branch
     """
+    from binarycpython.utils.grid import Population
 
-    version_info = return_binary_c_version_info(parsed=True)
+    version_pop = Population()
+    version_info = version_pop.return_binary_c_version_info(parsed=True)
+    # version_info = return_binary_c_version_info(parsed=True)
 
     git_revision = version_info["miscellaneous"]["git_revision"]
     git_branch = version_info["miscellaneous"]["git_branch"]

docs/source/_templates/footer.html

@@ -2,8 +2,8 @@
 
 {%- block extrafooter %}
 <br><br>
-Generated on binarycpython git branch: development_0.9.2/2.2.1 git revision d1fde5c9bf26c24340a5de90244686794e870ba3 url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python/-/tree/development_0.9.2/2.2.1">git url</a>.
+Generated on binarycpython git branch: development_0.9.3/2.2.1 git revision 9f0d89b99124813956c3fea2f1a26f137a069a16 url: <a href="https://gitlab.surrey.ac.uk/ri0005/binary_c-python/-/tree/development_0.9.3/2.2.1">git url</a>.
 <br><br>
-Using binary_c with bit branch branch_david: git revision: "5747:20211102:404ce27a0" url: <a href="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c/-/tree/branch_david">git url</a>.
+Using binary_c with bit branch branch_david: git revision: "5834:20211216:a3146490e" url: <a href="https://gitlab.surrey.ac.uk/ri0005/binary_c/-/tree/branch_david">git url</a>.
 
 {% endblock %}
\ No newline at end of file

docs/source/binary_c_parameters.rst

@@ -4,7 +4,7 @@ The following chapter contains all the parameters that the current version of bi
 
 
 This information was obtained by the following binary_c build:
-	**binary_c git branch**: branch_david	**binary_c git revision**: 5747:20211102:404ce27a0	**Built on**: Nov  2 2021 23:57:35
+	**binary_c git branch**: branch_david	**binary_c git revision**: 5834:20211216:a3146490e	**Built on**: Dec 20 2021 20:33:01
 
 
 Section: stars
@@ -288,10 +288,10 @@ Section: stars
 | **Macros**: ['OPACITY_ALGORITHM_PACZYNSKI = 0', 'OPACITY_ALGORITHM_FERGUSON_OPAL = 1', 'OPACITY_ALGORITHM_STARS = 2']
 
 | **Parameter**: wind_mass_loss
-| **Description**: Defines the algorithm used for stellar winds. 0 = none, 1 = Hurley et al. (2002), 2 = Schneider (2018).
+| **Description**: Defines the algorithm used for stellar winds. 0 = none, 1 = Hurley et al. (2002), 2 = Schneider (2018), 3 = Schneider + Sander and Wink (2020) for helium stars, 4 = Schneider + Hurley for LBV mass loss
 | **Parameter input type**: Unsigned integer
 | **Default value**: 3
-| **Macros**: ['WIND_ALGORITHM_NONE = 0', 'WIND_ALGORITHM_HURLEY2002 = 1', 'WIND_ALGORITHM_SCHNEIDER2018 = 2', 'WIND_ALGORITHM_BINARY_C_2020 = 3']
+| **Macros**: ['WIND_ALGORITHM_NONE = 0', 'WIND_ALGORITHM_HURLEY2002 = 1', 'WIND_ALGORITHM_SCHNEIDER2018 = 2', 'WIND_ALGORITHM_BINARY_C_2020 = 3', 'WIND_ALGORITHM_HENDRIKS_2022 = 4']
 | **Extra**: 0
 
 | **Parameter**: gbwind
@@ -486,6 +486,12 @@ Section: stars
 | **Default value**: 0
 | **Extra**: Ignore
 
+| **Parameter**: PPISN_core_mass_range_shift
+| **Description**: (Pulsational) Pair-Instability Supernova CO core mass range shift: Value by which we shift the range of CO core mass values that undergo PPISN. This is taken into account in the fit that calculates the mass removal. Negative number is shifting the range to lower masses, positive to higher masses.
+| **Parameter input type**: Float
+| **Default value**: 0
+| **Extra**: Ignore
+
 | **Parameter**: use_LWN_fallback
 | **Description**: Flag whether to use the Nazehdin-Lovegrove-Woosley hydrogen envelope ejection at failed supernova.
 | **Parameter input type**: Integer
@@ -561,7 +567,7 @@ Section: stars
 | **Parameter**: sn_kick_distribution_PPISN
 | **Description**: Set the distribution of speeds applied to PPISN supernovae. 0=fixed, 1=maxwellian (hurley/BSE), 2=custom function (see monte_carlo_kicks.c).
 | **Parameter input type**: Integer
-| **Default value**: 1
+| **Default value**: 0
 | **Macros**: ['KICK_VELOCITY_FIXED = 0', 'KICK_VELOCITY_MAXWELLIAN = 1', 'KICK_VELOCITY_CUSTOM = 2']
 
 | **Parameter**: sn_kick_distribution_PISN
@@ -634,7 +640,7 @@ Section: stars
 | **Parameter**: sn_kick_dispersion_PPISN
 | **Description**: Set the dispersion of speeds applied to the survivor of a PPISN supernova. 0=fixed, 1=maxwellian (hurley/BSE), 2=custom function (see monte_carlo_kicks.c).
 | **Parameter input type**: Float
-| **Default value**: 190
+| **Default value**: 0
 
 | **Parameter**: sn_kick_dispersion_PISN
 | **Description**: Set the dispersion of speeds applied to the survivor of a PISN supernova. 0=fixed, 1=maxwellian (hurley/BSE), 2=custom function (see monte_carlo_kicks.c).
@@ -968,7 +974,7 @@ Section: stars
 | **Parameter**: MINT_metallicity
 | **Description**: This sets the metallicity for MINT. It is ignored if set to -1.0, the default, in which case the normal metallicity parameter is used.
 | **Parameter input type**: Float
-| **Default value**: NULL
+| **Default value**: -1
 
 | **Parameter**: gaia_Teff_binwidth
 | **Description**: log10(Effective temperature) bin width used to make Gaia-like HRDs
@@ -1153,6 +1159,21 @@ Section: stars
 | **Parameter input type**: True|False
 | **Default value**: False
 
+| **Parameter**: degenerate_core_merger_nucsyn
+| **Description**: If TRUE, assume that in a degnerate core merger, energy is generated from nucleosynthesis of the whole core, and that this can disrupt the core. The BSE algorithm (Hurley et al. 2002) assumes this to be TRUE, but binary_c assumes FALSE by default. (FALSE)
+| **Parameter input type**: True|False
+| **Default value**: False
+
+| **Parameter**: degenerate_core_helium_merger_ignition
+| **Description**: If TRUE, assume that when there is a degenerate helium core merger, the star reignites helium. This is required to make R-type carbon stars. (TRUE)
+| **Parameter input type**: True|False
+| **Default value**: True
+
+| **Parameter**: degenerate_core_merger_dredgeup_fraction
+| **Description**: If non-zero, mix this fraction of the degenerate core during a merger.(0.0).
+| **Parameter input type**: Float
+| **Default value**: NULL
+
 Section: binary
 ---------------
 
@@ -1325,7 +1346,7 @@ Section: binary
 | **Parameter**: post_ce_objects_have_envelopes
 | **Description**: If TRUE then post-common-envelope objects have thin envelopes. You need this if you are to have post-CE post-AGB stars. Note that this *may* be unstable, i.e. you may end up having many CEEs. The mass in the envelope is controlled by post_ce_adaptive_menv. TRUE by default.
 | **Parameter input type**: True|False
-| **Default value**: True
+| **Default value**: False
 
 | **Parameter**: PN_comenv_transition_time
 | **Description**: post-common envelope transition time in years (1e2).  This is the time taken to move from CEE ejection to Teff > 30e4 K. Hall et al. (2013) suggest ~100 years.
@@ -1794,7 +1815,7 @@ Section: binary
 | **Default value**: NULL
 
 | **Parameter**: lambda_ce
-| **Description**: Common envelope parameter. The binding energy of the common envelope is G*M*Menv/(lambda*R). Typically this is taken to be 0.5, but if set to -1 binary_c uses the Dewi and Tauris fits instead, -2 uses the formalism of Wang, Jia and Li (2016) and if -3 then a polytropic formalism is used (see also comenv_splitmass).
+| **Description**: Common envelope parameter. The binding energy of the common envelope is G*M*Menv/(lambda*R). Typically this is taken to be 0.5, but if set to LAMBDA_CE_DEWI_TAURIS == -1 binary_c uses the Dewi and Tauris fits instead, LAMBDA_CE_WANG_2016 == -2 uses the formalism of Wang, Jia and Li (2016), if LAMBDA_CE_POLYTROPE == -3 then a polytropic formalism is used (see also comenv_splitmass) and if LAMBDA_CE_KLENCKI_2020 == -4 use Klencki et al. (2020).
 | **Parameter input type**: Float
 | **Default value**: 0.5
 | **Macros**: ['LAMBDA_CE_DEWI_TAURIS = -1', 'LAMBDA_CE_WANG_2016 = -2', 'LAMBDA_CE_POLYTROPE = -3', 'LAMBDA_CE_KLENCKI_2020 = -4']
@@ -2593,105 +2614,111 @@ Section: output
 | **Default value**: NULL
 | **Extra**: Ignore
 
+| **Parameter**: tides_diagnosis_log
+| **Description**: Enable logging to test MINT tides. Requires MINT. Choices are: 0 disabled, 1 enable lambda test.
+| **Parameter input type**: Integer
+| **Default value**: 0
+| **Extra**: Ignore
+
 Section: input
 --------------
 
 | **Parameter**: MINT_dir
 | **Description**: Location of MINT algorithm data.
 | **Parameter input type**: String
-| **Default value**: NULL
+| **Default value**: 
 | **Extra**: 
 
 | **Parameter**: MINT_data_cleanup
 | **Description**: Activate checks on incoming data to try to account for problems. Will make data-loading slower, but may fix a few things.
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: False
 | **Extra**: 
 
 | **Parameter**: MINT_MS_rejuvenation
 | **Description**: Turn on or off (hydrogen) main-sequence rejuvenation.
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: True
 | **Extra**: 
 
 | **Parameter**: MINT_remesh
 | **Description**: Turn on or off MINT's remeshing.
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: True
 | **Extra**: 
 
 | **Parameter**: MINT_use_ZAMS_profiles
 | **Description**: Use chemical profiles at the ZAMS if MINT_use_ZAMS_profiles is TRUE, otherwise set homogeneous abundances. (Default is TRUE, so we use the profiles if they are available.)
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: True
 | **Extra**: 
 
 | **Parameter**: MINT_fallback_to_test_data
 | **Description**: If TRUE, use the MINT test_data directory as a fallback when data is unavailable. (FALSE)
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: False
 | **Extra**: 
 
 | **Parameter**: MINT_disable_grid_load_warnings
 | **Description**: Use this to explicitly disable MINT's warnings when loading a grid with, e.g., missing or too much data.
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: False
 | **Extra**: 
 
 | **Parameter**: MINT_Kippenhahn
 | **Description**: Turn on or off MINT's Kippenhahn diagrams. If 0, off, if 1, output star 1 (index 0), if 2 output star 2 (index 1). Default 0.
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: 0
 | **Extra**: 
 
 | **Parameter**: MINT_nshells
 | **Description**: Set the initial number of shells MINT uses in each star when doing nuclear burning. Note: remeshing can change this. If MINT_nshells is 0, shellular burning and other routines that require shells will not be available. (200)
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: 200
 | **Extra**: 
 
 | **Parameter**: MINT_maximum_nshells
 | **Description**: Set the maximum number of shells MINT uses in each star when doing nuclear burning. Note that this will be limited to MINT_HARD_MAX_NSHELLS. (1000)
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: 1000
 | **Extra**: 
 
 | **Parameter**: MINT_minimum_nshells
 | **Description**: Set the minimum number of shells MINT uses in each star when doing nuclear burning. Note that this will be greater than or equal to MINT_HARD_MIN_NSHELLS, which is 0 by default. (0)
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: 10
 | **Extra**: 
 
 | **Parameter**: MINT_Kippenhahn_stellar_type
 | **Description**: Stellar type selector for Kippenhahn plots. Set to -1 to ignore, otherwise the stellar type number for which Kippenhahn plot data should be output.
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: -1
 | **Macros**: ['LOW_MASS_MS = 0', 'MS = 1', 'HG = 2', 'GIANT_BRANCH = 3', 'CHeB = 4', 'EAGB = 5', 'TPAGB = 6', 'HeMS = 7', 'HeHG = 8', 'HeGB = 9', 'HeWD = 10', 'COWD = 11', 'ONeWD = 12', 'NS = 13', 'BH = 14', 'MASSLESS_REMNANT = 15']
 | **Extra**: 
 
 | **Parameter**: MINT_Kippenhahn_companion_stellar_type
 | **Description**: Companion stellar type selector for Kippenhahn plots. Set to -1 to ignore, otherwise the stellar type number for the companion for which Kippenhahn plot data should be output.
 | **Parameter input type**: Integer
-| **Default value**: NULL
+| **Default value**: -1
 | **Macros**: ['LOW_MASS_MS = 0', 'MS = 1', 'HG = 2', 'GIANT_BRANCH = 3', 'CHeB = 4', 'EAGB = 5', 'TPAGB = 6', 'HeMS = 7', 'HeHG = 8', 'HeGB = 9', 'HeWD = 10', 'COWD = 11', 'ONeWD = 12', 'NS = 13', 'BH = 14', 'MASSLESS_REMNANT = 15']
 | **Extra**: 
 
 | **Parameter**: MINT_nuclear_burning
 | **Description**: Turn on or off MINT's nuclear burning algorithm.
 | **Parameter input type**: True|False
-| **Default value**: NULL
+| **Default value**: False
 | **Extra**: 
 
 | **Parameter**: MINT_minimum_shell_mass
 | **Description**: Minimum shell mass in MINT's nuclear burning routines.
 | **Parameter input type**: Float
-| **Default value**: NULL
+| **Default value**: 1e-06
 | **Extra**: 
 
 | **Parameter**: MINT_maximum_shell_mass
 | **Description**: Maximum shell mass in MINT's nuclear burning routines. :
 | **Parameter input type**: Float
-| **Default value**: NULL
+| **Default value**: 0.1
 | **Extra**: 
 
 Section: i/o