cosmic-popsynth 3.6.1__tar.gz → 3.6.2__tar.gz

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/.github/workflows/build_wheels_and_publish.yml

@@ -6,79 +6,74 @@ on:
   workflow_dispatch:
 
 env:
-  CIBW_BUILD: "cp39-* cp310-* cp311-* cp312-*"
+  CIBW_BUILD: "cp310-* cp311-* cp312-* cp313-*"
   CIBW_ARCHS_LINUX: "x86_64"
   CIBW_SKIP: "*-win32 *musllinux*"
   CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
   CIBW_BEFORE_BUILD: pip install numpy --config-settings=setup-args="-Dallow-noblas=true"
   CIBW_BUILD_VERBOSITY: "1"
+  CIBW_BEFORE_ALL_LINUX: yum install -y gcc-gfortran
+  CIBW_ENVIRONMENT_LINUX: "FC=gfortran F77=gfortran"
+  CIBW_ENVIRONMENT_MACOS: "FC=gfortran F77=gfortran MACOSX_DEPLOYMENT_TARGET=14.0"
 
 jobs:
   build-wheels-and-dist:
-    name: Build ${{ matrix.python-version }} wheels on ${{ matrix.os }}
+    name: Build wheels on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        python-version: [3.9, "3.10", "3.11", "3.12"]
+        os: [ubuntu-latest, macos-14]
 
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+
+    # this step only uses a single python version since cibuildwheel
+    # builds multiple versions in one go on linux
     - uses: actions/setup-python@v5
       name: Install Python
       with:
-        python-version: "3.10"
+        python-version: "3.12"
 
-    - name: link gfortran and hdf5
+    - name: Install hdf5 (macOS)
       if: runner.os == 'macOS'
       run: |
-        sudo ln -s /opt/homebrew/bin/gfortran-12 /usr/local/bin/gfortran
-        brew reinstall hdf5
+        brew install hdf5
         
     - name: Install numpy
       run: |
         python -m pip install --upgrade pip
-        python -m pip install numpy h5py versioneer 
+        python -m pip install numpy h5py versioneer
 
     - name: Install dependencies
       run: |
         python -m pip install setuptools wheel build meson-python ninja meson pytest cibuildwheel
 
-    - name: Build source and wheels distribution on MacOS
+    - name: Set up Fortran (macOS)
       if: runner.os == 'macOS'
-      run: |
-        python -m build --outdir dist
-        find ./dist/*.whl | xargs pip install
-        pytest src/cosmic
+      uses: fortran-lang/setup-fortran@v1
+      with:
+        compiler: gcc
+        version: '13'
         
     - name: Build source and wheels distribution on Linux
-      if: runner.os == 'Linux'
       run: |
         python -m build --sdist --outdir dist
         python -m cibuildwheel --output-dir dist
         
     - uses: actions/upload-artifact@v4
       with:
-        name: dist-${{ matrix.os }}-${{ matrix.python-version }}
+        name: dist-${{ matrix.os }}
         path: ./dist/*
 
   publish:
     needs: [build-wheels-and-dist]
-    name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python-version: ["3.10"]
+    name: Publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
 
     - name: Download artifacts
       uses: actions/download-artifact@v4

cosmic_popsynth-3.6.2/.github/workflows/cmc-review.yml

@@ -0,0 +1,76 @@
+name: Flag CMC review for cosmic changes
+
+on:
+  pull_request_target:
+    types: [opened, reopened, synchronize]
+    paths:
+      - 'src/cosmic/utils.py'
+      - 'src/cosmic/evolve.py'
+      - 'docs/cosmic-settings.json'
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  flag-cmc-review:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: add "needs-cmc-review" label
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const labelName = 'needs-cmc-review';
+
+            // ensure the label exists, or create it
+            try {
+              await github.rest.issues.getLabel({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                name: labelName,
+              });
+            } catch (error) {
+              if (error.status === 404) {
+                await github.rest.issues.createLabel({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  name: labelName,
+                  color: 'fbca04',
+                  description: 'PR touches cosmic core settings and needs CMC review',
+                });
+              } else {
+                throw error;
+              }
+            }
+
+            // add the label to the PR
+            await github.rest.issues.addLabels({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              labels: [labelName],
+            });
+
+      - name: comment to request CMC review
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const body = `
+            🚨 **CMC review requested**
+
+            This pull request modifies one or more of the following files:
+
+            - \`src/cosmic/utils.py\`
+            - \`docs/cosmic-settings.json\`
+            - \`src/cosmic/evolve.py\`
+
+            A CMC developer should review this PR to ensure corresponding changes are propagated upstream as needed.
+            `;
+
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              body,
+            });

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/.github/workflows/python-package.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v4
@@ -32,19 +32,16 @@ jobs:
           ${{ runner.os }}-
     - name: Install dependencies and package
       run: |
+        # upgrade apt-get and install system dependencies
         sudo apt-get update
         sudo apt-get install gfortran swig libhdf5-serial-dev meson python3-dev
+
+        # upgrade pip and install dependencies
+        python -m pip install -U pip setuptools wheel packaging flake8
         pip install numpy ninja pytest
         pip install -r requirements.txt
         python -m pip install .
         
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude docs
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude docs,versioneer.py,cosmic/_version.py,cosmic/tests,cosmic/*/__init__.py
-
     - name: Test with pytest
       run: |
         bash ci/compile_benchmark.sh

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/.gitignore

@@ -115,3 +115,4 @@ binary.in
 binary.dat
 *.h5
 fort.99
+savefig/

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cosmic-popsynth
-Version: 3.6.1
+Version: 3.6.2
 Summary: a Python-interfaced binary population synthesis suite
 Author: Scott Coughlin, Michael Zevin, Carl L. Rodriguez, Tom Wagg
 Author-Email: Katelyn Breivik <katie.breivik@gmail.com>
@@ -11,7 +11,7 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: astropy
@@ -22,7 +22,6 @@ Requires-Dist: tables
 Requires-Dist: h5py
 Requires-Dist: schwimmbad
 Requires-Dist: matplotlib
-Requires-Dist: importlib-metadata
 Description-Content-Type: text/markdown
 
 # COSMIC

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/bin/cosmic-pop

@@ -22,10 +22,12 @@ import numpy as np
 import pandas as pd
 from pandas.errors import PerformanceWarning
 import warnings
+import h5py as h5
 
 from cosmic.sample.initialbinarytable import InitialBinaryTable
 from cosmic import Match, utils
 from cosmic.evolve import Evolve
+from cosmic._version import __version__
 
 from schwimmbad import MPIPool
 from os import sys
@@ -105,9 +107,9 @@ def parse_commandline():
     parser.add_argument("--binary_state", nargs='+', type=int)
     parser.add_argument("--sampling_method")
     parser.add_argument("--primary_model", help="Chooses the initial primary mass function from: salpeter55, kroupa93, kroupa01", type=str)
-    parser.add_argument("--binfrac_model", help="Chooses the binary fraction model from: a float between [0,1], vanHaaften, and offner22", type=binfrac_type)
+    parser.add_argument("--binfrac_model", help="Chooses the binary fraction model from: a float between [0,1], vanHaaften, and offner23", type=binfrac_type)
     parser.add_argument("--ecc_model", help="Chooses the initial eccentricity distribution model from: thermal, uniform, and sana12", type=str)
-    parser.add_argument("--porb_model", help="Chooses the initial orbital period distribution model from: log_uniform and sana12", type=str)
+    parser.add_argument("--porb_model", help="Chooses the initial orbital period distribution model from: log_uniform, sana12, renzo19, raghavan10, moe19, and martinez26", type=str)
     parser.add_argument("--SF_start", help="Sets the time in the past when star formation initiates in Myr", type=float)
     parser.add_argument("--SF_duration", help="Sets the duration of constant star formation in Myr", type=float)
     parser.add_argument("--metallicity", type=float)
@@ -266,18 +268,11 @@ if __name__ == '__main__':
         idx = 0
         log_file = open('log_kstar1_{0}_kstar2_{1}_SFstart_{2}_SFduration_{3}_metallicity_{4}.txt'.format(kstar1_range_string, kstar2_range_string, sampling['SF_start'], sampling['SF_duration'], sampling['metallicity']), 'w')
 
-    # save configuration settings to output file
-    configuration_settings = {'BSEDict' : BSEDict, 'filters' : filters,
-                              'convergence' : convergence, 'sampling' : sampling}
-
-    with warnings.catch_warnings():
-        warnings.simplefilter(action="ignore", category=PerformanceWarning)
-        
-        with pd.HDFStore(dat_store_fname,complib=args.complib,complevel=args.complevel) as dat_store:
-            for k, v in configuration_settings.items():
-                for k1, v1 in v.items():
-                    dat_store.put('config/{0}/{1}/'.format(k, k1), pd.Series(v1))
-            dat_store.put('config/rand_seed/', pd.Series(seed_int))
+    # save configuration settings and COSMIC version to output file
+    with h5.File(dat_store_fname, 'a') as f:
+        f["config"] = json.dumps({'BSEDict' : BSEDict, 'filters' : filters, 'convergence' : convergence,
+                                  'sampling' : sampling, 'rand_seed': seed_int})
+        f.attrs['COSMIC_version'] = __version__
 
     # Initialize the step counter and convergence array/list
     Nstep = idx - np.mod(idx, args.Nstep)

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/changelog.md

@@ -55,3 +55,7 @@ See the discussed changes in our previous releases here: https://github.com/COSM
 ## 3.6.1
  - Add support for single stars in both independent and multidim sampling
  - update documentation
+
+## 3.6.2
+ - Add functions to `cosmic.utils` for initC IO that's more efficient (`save_initC`, `load_initC`) by saving
+ identical setting columns separately with only one copy - saves ~1kb per binary

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/docs/create_params_ini.py

@@ -99,7 +99,7 @@ def construct_ini_from_json(config, include_comments=True):
 
 def main():
     # read the config file
-    with open("cosmic-settings.json") as f:
+    with open("../src/cosmic/data/cosmic-settings.json") as f:
         config = json.load(f)
 
     # convert it to an INI file, replace HTML tags and save the output

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/docs/create_settings_html.py

@@ -46,7 +46,7 @@ settings_template = """<div class="setting">
 option_template = """<li><code class="docutils literal notranslate"><span class="pre opt-val"></span></code>: <span class="opt-desc"></span></li>"""
 
 # read the settings file
-with open("cosmic-settings.json") as f:
+with open("../src/cosmic/data/cosmic-settings.json") as f:
     settings = json.load(f)
 
 # go through each major settings group

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.6.2}/docs/pages/config/config_insert_bse.html

@@ -128,7 +128,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface">\( 10^{-13} {\rm \ \texttt{hewind} \ } L^{2/3}\) gives He star mass-loss. Equivalent to \(1 - \mu\) in the last equation on <a href="https://ui.adsabs.harvard.edu/abs/2000MNRAS.315..543H/abstract">Hurley+2000, page 19</a>.</p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Sets the helium star mass loss parameter</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default value</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 1]</span></code>: <span class="opt-desc">Sets the helium star mass loss parameter</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default value</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -156,7 +156,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface">Corresponds to \(\mu_w\) in <a href="https://ui.adsabs.harvard.edu/abs/2002MNRAS.329..897H/abstract">Hurley+2002, Eq. 11</a></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Sets the wind accretion efficiency factor</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default value</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 1]</span></code>: <span class="opt-desc">Sets the wind accretion efficiency factor</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default value</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -198,7 +198,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">uses variable lambda prescription detailed in appendix of <a href="https://ui.adsabs.harvard.edu/abs/2014A%26A...563A..83C/abstract">Claeys+2014</a> where lambdaf is the fraction of the ionization energy that can go into ejecting the envelope; to use this prescription without extra ionization energy, set lambdaf = 0</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">As above, this is the default choice</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-1.0</span></code>: <span class="opt-desc">Uses a fixed value (i.e. fixes \( \lambda \) to a value of -lambdaf)</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">uses variable lambda prescription detailed in appendix of <a href="https://ui.adsabs.harvard.edu/abs/2014A%26A...563A..83C/abstract">Claeys+2014</a> where lambdaf is the fraction of the ionization energy that can go into ejecting the envelope; to use this prescription without extra ionization energy, set lambdaf = 0</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">As above, this is the default choice</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">negative values</span></code>: <span class="opt-desc">Uses a fixed value (i.e. fixes \( \lambda \) to a value of -lambdaf)</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -261,9 +261,9 @@
 <div class="col-9">
 <h3 class="name"><code>qcflag</code></h3>
 <p class="description">Selects model to determine critical mass ratios for the onset of unstable mass transfer and/or a common envelope during RLO. NOTE: this is overridden by <code>qcrit_array</code> if any of its values are non-zero.</p>
-<p class="default">Default: 1</p>
+<p class="default">Default: 5</p>
 </div>
-<div class="col-3"><select class="form-control"><option value="0">0</option><option selected="true" value="1">1</option><option value="2">2</option><option value="3">3</option><option value="4">4</option><option value="5">5</option></select></div>
+<div class="col-3"><select class="form-control"><option value="0">0</option><option value="1">1</option><option value="2">2</option><option value="3">3</option><option value="4">4</option><option selected="true" value="5">5</option></select></div>
 </div>
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
@@ -404,12 +404,12 @@
 <p class="description">Sets the particular natal kick prescription to use. Note that <code class="docutils literal notranslate"><span class="pre">sigmadiv</span></code>, <code class="docutils literal notranslate"><span class="pre">bhflag</span></code>, <code class="docutils literal notranslate"><span class="pre">bhsigmafrac</span></code>, <code class="docutils literal notranslate"><span class="pre">aic</span></code>, and <code class="docutils literal notranslate"><span class="pre">ussn</span></code>, which are described below, are only used when <code class="docutils literal notranslate"><span class="pre">abs(kickflag)=1</span></code>. Positive values use the Pfahl+2002 prescription for handling natal kicks.</p>
 <p class="default">Default: 1</p>
 </div>
-<div class="col-3"><select class="form-control"><option selected="true" value="1">1</option><option value="2">2</option><option value="3">3</option><option value="4">4</option><option value="negative values">negative values</option></select></div>
+<div class="col-3"><select class="form-control"><option selected="true" value="1">1</option><option value="2">2</option><option value="3">3</option><option value="4">4</option><option value="5">5</option><option value="-1">-1</option><option value="-2">-2</option><option value="-3">-3</option><option value="-4">-4</option></select></div>
 </div>
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">1</span></code>: <span class="opt-desc">The standard COSMIC kick prescription, where kicks are drawn from a bimodal distribution with standard FeCCSN getting a kick drawn from a Maxwellian distribution with dispersion parameter <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and ECSN/USSN are drawn according to <code class="docutils literal notranslate"><span class="pre">sigmadiv</span></code>. This setting has additional possible options for <code class="docutils literal notranslate"><span class="pre">bhflag</span></code>, <code class="docutils literal notranslate"><span class="pre">bhsigmafrac</span></code>, <code class="docutils literal notranslate"><span class="pre">aic</span></code> and <code class="docutils literal notranslate"><span class="pre">ussn</span></code>.</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">2</span></code>: <span class="opt-desc">Natal kicks are drawn according to <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and scaled by the ejecta mass and remnant mass following Eq. 1 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2020ApJ...891..141G/abstract">Giacobbo &amp; Mapelli 2020</a> with their default parameters (\(m_{\rm NS = 1.2 {\rm M_\odot}\), \(m_{\rm ej = 9 {\rm M_\odot}\))</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">3</span></code>: <span class="opt-desc">Natal kicks are drawn according to <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and scaled by just the ejecta mass following Eq. 2 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2020ApJ...891..141G/abstract">Giacobbo &amp; Mapelli 2020</a>, which does not scale the kick by (\(m_{\rm NS\)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">4</span></code>: <span class="opt-desc">Natal kicks are drawn according to Eq. 1 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2016MNRAS.461.3747B/abstract">Bray &amp; Eldridge 2016</a>, with their default parameters (\(\alpha=70 \, {\rm km/s}, \beta = 120 \, {\rm km/s)}</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">negative values</span></code>: <span class="opt-desc">Same as above settings but using the old Kiel &amp; Hurley 2009 prescription for changing the orbital configuration of the binary, available for reproducibility purposes but not recommended for new work</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">1</span></code>: <span class="opt-desc">The standard COSMIC kick prescription, where kicks are drawn from a bimodal distribution with standard FeCCSN getting a kick drawn from a Maxwellian distribution with dispersion parameter <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and ECSN/USSN are drawn according to <code class="docutils literal notranslate"><span class="pre">sigmadiv</span></code>. This setting has additional possible options for <code class="docutils literal notranslate"><span class="pre">bhflag</span></code>, <code class="docutils literal notranslate"><span class="pre">bhsigmafrac</span></code>, <code class="docutils literal notranslate"><span class="pre">aic</span></code> and <code class="docutils literal notranslate"><span class="pre">ussn</span></code>.</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">2</span></code>: <span class="opt-desc">Natal kicks are drawn according to <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and scaled by the ejecta mass and remnant mass following Eq. 1 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2020ApJ...891..141G/abstract">Giacobbo &amp; Mapelli 2020</a> with their default parameters (\(m_{\rm NS = 1.2 {\rm M_\odot}\), \(m_{\rm ej = 9 {\rm M_\odot}\))</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">3</span></code>: <span class="opt-desc">Natal kicks are drawn according to <code class="docutils literal notranslate"><span class="pre">sigma</span></code> and scaled by just the ejecta mass following Eq. 2 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2020ApJ...891..141G/abstract">Giacobbo &amp; Mapelli 2020</a>, which does not scale the kick by (\(m_{\rm NS\)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">4</span></code>: <span class="opt-desc">Natal kicks are drawn according to Eq. 1 of <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2016MNRAS.461.3747B/abstract">Bray &amp; Eldridge 2016</a>, with their default parameters (\(\alpha=70 \, {\rm km/s}, \beta = 120 \, {\rm km/s)}</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">5</span></code>: <span class="opt-desc">Follows the same prescription as 1, but uses the kick prescription described in <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2025arXiv250522102D/abstract">Disberg &amp; Mandel 2025</a> for CCSN.</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-1</span></code>: <span class="opt-desc">As 1, but using the old Kiel &amp; Hurley 2009 prescription for changing the orbital configuration of the binary, available for reproducibility purposes but not recommended for new work</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-2</span></code>: <span class="opt-desc">As 2, but using the old Kiel &amp; Hurley 2009 prescription for changing the orbital configuration of the binary, available for reproducibility purposes but not recommended for new work</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-3</span></code>: <span class="opt-desc">As 3, but using the old Kiel &amp; Hurley 2009 prescription for changing the orbital configuration of the binary, available for reproducibility purposes but not recommended for new work</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-4</span></code>: <span class="opt-desc">As 4, but using the old Kiel &amp; Hurley 2009 prescription for changing the orbital configuration of the binary, available for reproducibility purposes but not recommended for new work</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -423,7 +423,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Sets the dispersion in the Maxwellian for the SN kick velocity in km/s</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">265.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Sets the dispersion in the Maxwellian for the SN kick velocity in km/s</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">No natal kicks for core-collapse when using Hobbs kicks</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">265.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -451,7 +451,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">values between [0, 1]</span></code>: <span class="opt-desc">reduces sigma by bhsigmafrac for BHs</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range (0, 1]</span></code>: <span class="opt-desc">reduces sigma by bhsigmafrac for BHs</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -484,7 +484,7 @@
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
 <div class="col-9">
-<h3 class="name"><code>ecsn_low</code></h3>
+<h3 class="name"><code>ecsn_mlow</code></h3>
 <p class="description">Sets the low end of the ECSN mass range</p>
 <p class="default">Default: 1.6</p>
 </div>
@@ -493,7 +493,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets maximum He-star mass for ECSN; <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2002MNRAS.329..897H/abstract">BSE (Hurley+2002)</a> uses ecsn_mlow = 1.6, <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2008ApJS..174..223B/abstract">StarTrack (Belczynski+2008)</a> uses ecsn_mlow = 1.85, <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2004ApJ...612.1044P/abstract">Podsiadlowksi+2004</a> argues that binarity can decrease this to ecsn_mlow = 1.4</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.6</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets maximum He-star mass for ECSN; <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2002MNRAS.329..897H/abstract">BSE (Hurley+2002)</a> uses ecsn_mlow = 1.6, <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2008ApJS..174..223B/abstract">StarTrack (Belczynski+2008)</a> uses ecsn_mlow = 1.85, <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2004ApJ...612.1044P/abstract">Podsiadlowksi+2004</a> argues that binarity can decrease this to ecsn_mlow = 1.4</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">no lower limit on He-star mass for ECSN</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.6</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -549,7 +549,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">values between [0, 90]</span></code>: <span class="opt-desc">Sets the opening angle of the SN kick relative to the pole of the exploding star</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">Strictly polar kicks</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">90.0</span></code>: <span class="opt-desc">Fully isotropic kicks (default choice)</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 90]</span></code>: <span class="opt-desc">Sets the opening angle of the SN kick relative to the pole of the exploding star</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">Strictly polar kicks</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">90.0</span></code>: <span class="opt-desc">Fully isotropic kicks (default choice)</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -605,7 +605,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets the maximum amount of mass loss, which should be about 10% of the maximum mass of an iron core (\({\sim 5 \mathrm{M}_\odot}\) Fryer, private communication)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">values in [-1, 0)</span></code>: <span class="opt-desc">assumes that proto-compact objects lose a constant fraction of their baryonic mass when collapsing to a black hole, such that \(M_{\rm rem} = (1 + \texttt{rembar\_massloss}) M_{\rm rem}\) (e.g., rembar_massloss = -0.1 gives the black hole a gravitational mass that is 90% of the proto-compact object's baryonic mass)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets the maximum amount of mass loss, which should be about 10% of the maximum mass of an iron core (\({\sim 5 \mathrm{M}_\odot}\) Fryer, private communication)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">range [-1, 0]</span></code>: <span class="opt-desc">assumes that proto-compact objects lose a constant fraction of their baryonic mass when collapsing to a black hole, such that \(M_{\rm rem} = (1 + \texttt{rembar\_massloss}) M_{\rm rem}\) (e.g., rembar_massloss = -0.1 gives the black hole a gravitational mass that is 90% of the proto-compact object's baryonic mass)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.5</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -647,7 +647,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Sets either the spin of all BHs or the upper limit of the uniform distribution for BH spins (see bhspinflag)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 1]</span></code>: <span class="opt-desc">Sets either the spin of all BHs or the upper limit of the uniform distribution for BH spins (see bhspinflag)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="settings-section"><h2 id="gr-orbital-decay">GR Orbital Decay</h2><hr/></div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -668,14 +668,14 @@
 <div class="col-9">
 <h3 class="name"><code>eddfac</code></h3>
 <p class="description">Eddington limit factor for mass transfer.</p>
-<p class="default">Default: 1</p>
+<p class="default">Default: 10</p>
 </div>
-<div class="col-3"><input class="form-control" type="number" value="1"/></div>
+<div class="col-3"><input class="form-control" type="number" value="10"/></div>
 </div>
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">1</span></code>: <span class="opt-desc">mass transfer rate is limited by the Eddington rate following Equation 67 in <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2002MNRAS.329..897H/abstract">Hurley+2002</a></span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">values &gt; 1</span></code>: <span class="opt-desc">permit super-Eddington accretion up to value <code>eddfac</code></span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">values in [0, 1]</span></code>: <span class="opt-desc">restrict accretion limit to fraction of Eddington (sub-Eddington accretion)</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">restrict accretion limit to fraction of Eddington (sub- or super-Eddington accretion)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0</span></code>: <span class="opt-desc">no mass transfer onto compact objects</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1</span></code>: <span class="opt-desc">mass transfer rate is limited by the Eddington rate following Equation 67 in <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2002MNRAS.329..897H/abstract">Hurley+2002</a></span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">10</span></code>: <span class="opt-desc">mass transfer rate is limited to 10x the Eddington rate</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -689,7 +689,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">-1</span></code>: <span class="opt-desc">assumes the lost material carries away the specific angular momentum of the primary</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-2</span></code>: <span class="opt-desc">assumes material is lost from the system as if it is a wind from the secondary</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-3</span></code>: <span class="opt-desc">assumes mass is lost through the outer Lagrangian point, forming a circumbinary disk. See Zapartas+17 Eq. 9 and Artymowicz &amp; Lubow (1994).</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">assumes that the lost material takes away a fraction <code>gamma</code> of the orbital angular momentum</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">-1</span></code>: <span class="opt-desc">assumes the lost material carries away the specific angular momentum of the primary</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-2</span></code>: <span class="opt-desc">assumes material is lost from the system as if it is a wind from the secondary</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-3</span></code>: <span class="opt-desc">assumes mass is lost through the outer Lagrangian point, forming a circumbinary disk. See Zapartas+17 Eq. 9 and Artymowicz &amp; Lubow (1994).</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">assumes that the lost material takes away a fraction <code>gamma</code> of the orbital angular momentum</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">no angular momentum loss from the system due to mass loss</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -717,7 +717,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">-1</span></code>: <span class="opt-desc">limited to 10x the thermal rate of the accretor for MS/HG/CHeB and unlimited for GB/EAGB/AGB stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-2</span></code>: <span class="opt-desc">limited to 1x the thermal rate of the accretor for MS/HG/CHeB and unlimited for GB/EAGB/AGB stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-3</span></code>: <span class="opt-desc">limited to 10x the thermal rate of the accretor for all stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-4</span></code>: <span class="opt-desc">limited to 1x the thermal rate of the accretor for all stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">&gt;= 0</span></code>: <span class="opt-desc">sets overall fraction of donor material that is accreted, with the rest being lost from the system (<code>acc_lim = 0.5</code> assumes 50% accretion efficiency as in <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2008ApJS..174..223B/abstract">Belczynski+2008</a>)</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">-1</span></code>: <span class="opt-desc">limited to 10x the thermal rate of the accretor for MS/HG/CHeB and unlimited for GB/EAGB/AGB stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-2</span></code>: <span class="opt-desc">limited to 1x the thermal rate of the accretor for MS/HG/CHeB and unlimited for GB/EAGB/AGB stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-3</span></code>: <span class="opt-desc">limited to 10x the thermal rate of the accretor for all stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">-4</span></code>: <span class="opt-desc">limited to 1x the thermal rate of the accretor for all stars</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets overall fraction of donor material that is accreted, with the rest being lost from the system (<code>acc_lim = 0.5</code> assumes 50% accretion efficiency as in <a class="reference external" href="https://ui.adsabs.harvard.edu/abs/2008ApJS..174..223B/abstract">Belczynski+2008</a>)</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.0</span></code>: <span class="opt-desc">assume all mass is lost from the system (fully nonconservative)</span></li></ul>
 </div>
 </div><div class="settings-section"><h2 id="tides">Tides</h2><hr/></div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -801,7 +801,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">Retains epsnov fraction of accreted matter</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.001</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 1]</span></code>: <span class="opt-desc">Retains epsnov fraction of accreted matter</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">0.001</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="settings-section"><h2 id="pulsars">Pulsars</h2><hr/></div><div class="setting">
 <div class="row align-items-center setting-chooser">
@@ -857,7 +857,7 @@
 <div class="options-expander" style="color: lightcoral;">Option details <i class="fa fa-chevron-down"></i></div>
 <div class="row options hide">
 <p class="options-preface"></p>
-<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">positive values</span></code>: <span class="opt-desc">sets the mixing factor in main sequence star collisions</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
+<ul style="margin-left: 2rem; max-width: calc(100% - 2rem)"><li><code class="docutils literal notranslate"><span class="pre opt-val">range [0, 1]</span></code>: <span class="opt-desc">sets the mixing factor in main sequence star collisions</span></li><li><code class="docutils literal notranslate"><span class="pre opt-val">1.0</span></code>: <span class="opt-desc">Default choice</span></li></ul>
 </div>
 </div><div class="setting">
 <div class="row align-items-center setting-chooser">