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

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.7.0}/.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.7.0/.github/workflows/cmc-review.yml

@@ -0,0 +1,165 @@
+name: Flag CMC review for cosmic changes
+
+on:
+  pull_request_target:
+    types: [opened]
+    paths:
+      - 'src/cosmic/evolve.py'
+      - 'src/cosmic/data/cosmic-settings.json'
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  flag-cmc-review:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: decide whether to flag PR
+        id: decide
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const pull_number = context.payload.pull_request.number;
+
+            const SETTINGS_PATH = 'src/cosmic/data/cosmic-settings.json';
+
+            // helper: fetch file content at a specific ref (sha/branch)
+            async function fetchText(path, ref) {
+              const res = await github.rest.repos.getContent({ owner, repo, path, ref });
+              if (Array.isArray(res.data) || !res.data.content) {
+                throw new Error(`unexpected content response for ${path} at ${ref}`);
+              }
+              const buff = Buffer.from(res.data.content, res.data.encoding || 'base64');
+              return buff.toString('utf8');
+            }
+
+            // helper: count keys on the object with category === "bse"
+            // json is expected to be an array: [{category: "blah", ...}, {category: "bse", ...}]
+            // counts top-level keys excluding "category"
+            function bseKeyCount(jsonVal) {
+              if (!Array.isArray(jsonVal)) return 0;
+
+              const bseObj = jsonVal.find(
+                (x) => x && typeof x === 'object' && !Array.isArray(x) && x.category === 'bse'
+              );
+
+              if (!bseObj) return 0;
+
+              return Object.keys(bseObj).filter((k) => k === 'settings').length;
+            }
+
+            // list changed files in the PR
+            const files = await github.paginate(github.rest.pulls.listFiles, {
+              owner,
+              repo,
+              pull_number,
+              per_page: 100,
+            });
+
+            const changed = new Set(files.map(f => f.filename));
+            const changedEvolve = changed.has('src/cosmic/evolve.py');
+            const changedSettings = changed.has(SETTINGS_PATH);
+
+            let shouldFlag = false;
+            let reason = '';
+
+            // if evolve changed, always flag
+            if (changedEvolve) {
+              shouldFlag = true;
+              reason = 'evolve file changed, probably needs CMC review';
+            } else if (changedSettings) {
+              // only flag if bse key-count changes between base and head
+              const baseSha = context.payload.pull_request.base.sha;
+              const headSha = context.payload.pull_request.head.sha;
+
+              try {
+                const baseText = await fetchText(SETTINGS_PATH, baseSha);
+                const headText = await fetchText(SETTINGS_PATH, headSha);
+
+                const baseJson = JSON.parse(baseText);
+                const headJson = JSON.parse(headText);
+
+                const baseCount = bseKeyCount(baseJson);
+                const headCount = bseKeyCount(headJson);
+
+                if (baseCount !== headCount) {
+                  shouldFlag = true;
+                  reason = `bse key count changed (${baseCount} -> ${headCount})`;
+                } else {
+                  shouldFlag = false;
+                  reason = `bse key count unchanged (${baseCount})`;
+                }
+              } catch (err) {
+                // if parsing/fetching fails, be conservative and flag
+                shouldFlag = true;
+                reason = `could not compare bse key count safely (${err.message}); flagging for review`;
+              }
+            }
+
+            core.setOutput('should_flag', shouldFlag ? 'true' : 'false');
+            core.setOutput('reason', reason);
+
+      - name: add "needs-cmc-review" label
+        if: steps.decide.outputs.should_flag == 'true'
+        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;
+              }
+            }
+
+            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
+        if: steps.decide.outputs.should_flag == 'true'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const reason = `${{ toJSON(steps.decide.outputs.reason) }}`.replace(/^"|"$/g, '');
+
+            const body = `
+            🚨 **CMC review requested**
+
+            This pull request modifies one or more of:
+            - \`src/cosmic/evolve.py\`
+            - \`src/cosmic/data/cosmic-settings.json\` (only flagged when \`category: "bse"\` key-count changes)
+
+            **Trigger:** ${reason}
+
+            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.7.0}/.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.7.0}/.gitignore

@@ -115,3 +115,7 @@ binary.in
 binary.dat
 *.h5
 fort.99
+savefig/
+
+# ignore generated docs files
+_generated/

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cosmic-popsynth
-Version: 3.6.1
+Version: 3.7.0
 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.7.0}/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.7.0}/changelog.md

@@ -55,3 +55,18 @@ 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
+ - Make He and CO core masses available in output
+ - Change defaults; `qcflag=5` and `eccfac=10`
+ - Prevent users from supplying both `qmin` and `m2_min`
+ - Prevent users from supplying both `sep` and `porb` when sampling, calculate `porb` from `sep` as necessary
+ - Define `binstate=-1` as single stars
+
+## 3.7.0
+ - Add `remnantflag=5`: The Mandel & Muller 2020 prescription for remnant masses
+ - Add `kickflag=6`: The Mandel & Muller 2020 prescription for natal kicks. This can be tuned with `mm_mu_ns` and `mm_mu_bh`
+ - Add `remnantflag=6`: The Maltsev+25 and Willcox+25 prescription for remnant masses. This can be tuned with `maltsev_mode` and `maltsev_fallback`
+ - (Docs) Any tutorial that uses a plain BSEDict now uses one that is drawn from the cosmic-settings.json file to avoid missing changes and saves us updating each docs page

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.7.0}/docs/Makefile

@@ -55,6 +55,7 @@ clean:
 
 .PHONY: html
 html: apidoc
+	python generate_default_bsedict.py
 	python create_settings_html.py
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo

cosmic_popsynth-3.7.0/docs/_generated/README.md

@@ -0,0 +1,2 @@
+# _generated
+Generated docs files will be placed here

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.7.0}/docs/conf.py

@@ -15,6 +15,9 @@
 import sys
 import os
 import re
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).resolve().parent))
 
 from cosmic import __version__ as cosmic_version
 
@@ -144,6 +147,12 @@ pygments_style = 'monokai'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+# this runs before each plot directive
+plot_pre_code = """
+from generate_default_bsedict import get_default_BSE_settings
+default_BSEDict = get_default_BSE_settings(to_python=True)
+"""
+
 
 # -- Options for HTML output ----------------------------------------------
 

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.7.0}/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.7.0}/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
@@ -198,5 +198,5 @@ for group in settings:
     soup.select_one(".container-fluid").append(new_group)
 
     # write the soup out to an HTML file for this category
-    with open(f"pages/config/config_insert_{group['category']}.html", "w") as f:
+    with open(f"_generated/config_insert_{group['category']}.html", "w") as f:
         f.write(str(soup))

cosmic_popsynth-3.7.0/docs/generate_default_bsedict.py

@@ -0,0 +1,77 @@
+import json
+from pathlib import Path
+
+def get_default_BSE_settings(to_python=False):
+    """Get a copy of the default BSE settings from the COSMIC settings JSON file"""
+    json_path = (
+        Path(__file__).resolve().parent.parent
+        / "src"
+        / "cosmic"
+        / "data"
+        / "cosmic-settings.json"
+    )
+
+    with json_path.open(encoding="utf-8") as f:
+        cosmic_settings = json.load(f)
+
+    defaults = {}
+    # loop through settings to find bse
+    for cat in cosmic_settings:
+        if cat["category"] != "bse":
+            continue
+        
+        # go through each setting, finding the default option
+        for setting in cat["settings"]:
+            for option in setting["options"]:
+                if option.get("default", False):
+                    defaults[setting["name"]] = option["name"]
+
+    if to_python:
+        # ensure array settings are converted from strings to lists
+        for setting in ["qcrit_array", "natal_kick_array", "fprimc_array"]:
+            # this one requires special handling because of the fractions
+            if setting == "fprimc_array":
+                parts = defaults[setting].strip("[]").split(",")
+                defaults[setting] = [float(p.split("/")[0]) / float(p.split("/")[1]) for p in parts]
+            else:
+                defaults[setting] = json.loads(defaults[setting])
+
+    return defaults
+
+
+def generate_rst_bsedict(MAX_LINE_LENGTH=80):
+    """Generate the default BSE settings dictionary for use in documentation"""
+    defaults = get_default_BSE_settings()
+
+    indent_str = " " * 8
+
+    with open("_generated/default_bsedict.rst", "w") as f:
+        lines = [
+            ".. ipython:: python",
+            "",
+            "    BSEDict = {",
+        ]
+
+        first = True
+        current_line = indent_str
+        for k, v in defaults.items():
+            entry = f'"{k}": {v}'
+            if not first:
+                entry = ", " + entry
+            first = False
+
+            # check if adding this entry would exceed line length
+            if len(current_line) + len(entry) > MAX_LINE_LENGTH:
+                lines.append(current_line.rstrip() + ",")
+                current_line = indent_str + entry.lstrip(", ")
+            else:
+                current_line += entry
+
+        if current_line.strip():
+            lines.append(current_line.rstrip())
+        lines.append("    }")
+
+        f.write("\n".join(lines))
+
+if __name__ == "__main__":
+    generate_rst_bsedict()

{cosmic_popsynth-3.6.1 → cosmic_popsynth-3.7.0}/docs/pages/develop/adding-options.rst

@@ -13,7 +13,7 @@ Summary checklist
 Been here before and just making sure you're not missing anything? Here's a quick checklist:
 
 - ``src/cosmic/src``: Add the new option to the relevant COSMIC code file and **test your changes**!
-- ``docs/cosmic-settings.json``: Add the new option to the JSON file
+- ``src/cosmic/data/cosmic-settings.json``: Add the new option to the JSON file
 
 Code changes
 ------------

cosmic_popsynth-3.7.0/docs/pages/evolve/evolve_sample.rst

@@ -0,0 +1,48 @@
+*****************************************
+Evolving a Monte-Carlo sampled population
+*****************************************
+Once an initial binary population is sampled, it can be evolved using the ``Evolve`` class just as we've done so far.
+You can read more about sampling initial binary populations in the :ref:`runpop` page.
+
+Note that the same process used other examples applies here as well: the ``BSEDict`` must be supplied,
+if the flags in the dictionary change from their defaults.
+
+First, let's import the necessary modules from COSMIC:
+
+.. ipython:: python
+
+    from cosmic.sample.initialbinarytable import InitialBinaryTable
+
+    from cosmic.evolve import Evolve
+
+
+Now let's use the independent sampler to generate an initial binary population. You can learn more 
+about the independent sampler in the :ref:`independent` page.
+
+.. ipython:: python
+
+    final_kstars = range(16)
+
+    InitialBinaries, mass_singles, mass_binaries, n_singles, n_binaries = \
+          InitialBinaryTable.sampler('independent', final_kstars, final_kstars,
+                                     binfrac_model=0.5, primary_model='kroupa01',
+                                     ecc_model='sana12', porb_model='sana12',
+                                     qmin=-1, SF_start=13700.0,
+                                     SF_duration=0.0, met=0.02, size=10, keep_singles=True)
+
+
+And finally, we can evolve the initial binary population using the Evolve class as we've done in the previous
+guides:
+
+.. include:: ../../_generated/default_bsedict.rst
+
+.. ipython:: python
+    :okwarning:
+
+    bpp, bcm, initC, kick_info = Evolve.evolve(
+        initialbinarytable=InitialBinaries, BSEDict=BSEDict
+    )
+
+    print(bcm.iloc[:10])
+
+    print(bpp)

cosmic_popsynth-3.7.0/docs/pages/evolve/grid.rst

@@ -0,0 +1,43 @@
+*********************************
+Evolving a fixed grid of binaries
+*********************************
+
+Sometimes it is helpful to run a fixed grid of initial binaries to explore how
+changing a single parameter affects the evolved binary. Let's start by importing the necessary modules and
+setting up the BSEDict settings as we've done in the previous examples.
+
+.. ipython:: python
+
+    from cosmic.sample.initialbinarytable import InitialBinaryTable
+
+    from cosmic.evolve import Evolve
+
+.. include:: ../../_generated/default_bsedict.rst
+
+
+Here we evolve the same system that produces a GW150914-like binary, but run over several initial orbital
+periods spaced evenly in log space.
+
+.. ipython:: python
+    :okwarning:
+
+    n_grid = 10
+
+    binary_grid = InitialBinaryTable.InitialBinaries(
+        m1=np.ones(n_grid)*100.0,
+        m2=np.ones(n_grid)*85.0,
+        porb=np.logspace(3,5,n_grid),
+        ecc=np.ones(n_grid)*0.65,
+        tphysf=np.ones(n_grid)*13700.0,
+        kstar1=np.ones(n_grid),
+        kstar2=np.ones(n_grid),
+        metallicity=np.ones(n_grid)*0.005
+    )
+
+    print(binary_grid)
+
+    bpp, bcm, initC, kick_info = Evolve.evolve(initialbinarytable=binary_grid, BSEDict=BSEDict)
+
+    print(bpp)
+
+    print(bcm)