cosmic-popsynth 3.6.2__cp313-cp313-macosx_14_0_arm64.whl

cosmic/sample/sampler/sampler.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) Duncan Macleod (2013)
+#
+# This file is part of GWpy.
+#
+# GWpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# GWpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with GWpy.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Fetch registration for database queries
+"""
+
+import re
+
+from six import string_types
+
+from astropy.io.registry import IORegistryError
+from astropy.table import Table
+
+_SAMPLERS = {}
+
+__author__ = "Duncan Macleod <duncan.macleod@ligo.org>"
+
+
+def register_sampler(data_format, data_class, function, force=False, usage=None):
+    """Register a new method to InitialBinaryTable.sampler() for a given format
+
+    Parameters
+    ----------
+    data_format : `str`
+        name of the format to be registered
+
+    data_class : `type`
+        the class that the sampler returns
+
+    function : `callable`
+        the method to call from :meth:`InitialBinaryTable.sampler`
+
+    force : `bool`, optional
+        overwrite existing registration for ``data_format`` if found,
+        default: `False`
+    """
+    key = (data_format, data_class)
+    if key not in _SAMPLERS or force:
+        _SAMPLERS[key] = (function, usage)
+    else:
+        raise IORegistryError(
+            "Fetcher for format '{0}' and class '{1}' "
+            "has already been "
+            "defined".format(data_format, data_class)
+        )
+    _update__doc__(data_class)
+
+
+def get_sampler(data_format, data_class):
+    """Return the :meth:`~InitialBinaryTable.sampler` function for the given format
+
+    Parameters
+    ----------
+    data_format : `str`
+        name of the format
+
+    data_class : `type`
+        the class that the sampler returns
+
+    Raises
+    ------
+    astropy.io.registry.IORegistryError
+        if not registration is found matching ``data_format``
+    """
+    try:
+        return _SAMPLERS[(data_format, data_class)][0]
+    except KeyError:
+        formats = "\n".join(_SAMPLERS.keys())
+        raise IORegistryError(
+            "No sampler definer for format %r. "
+            "The available formats are:\n%r" % (data_format, formats)
+        )
+
+
+def _update__doc__(data_class):
+    header = "The available named formats are:"
+    sampler = data_class.sampler
+
+    # if __doc__ isn't a string, bail-out now
+    if not isinstance(sampler.__doc__, string_types):
+        return
+
+    # remove the old format list
+    lines = sampler.__doc__.splitlines()
+    try:
+        pos = [i for i, line in enumerate(lines) if header in line][0]
+    except IndexError:
+        pass
+    else:
+        lines = lines[:pos]
+
+    # work out the indentation
+    matches = [re.search(r"(\S)", line) for line in lines[1:]]
+    indent = min(match.start() for match in matches if match)
+
+    # now re-write the format list
+    formats = []
+    for fmt, cls in sorted(_SAMPLERS, key=lambda x: x[0]):
+        if cls is not data_class:
+            continue
+        usage = _SAMPLERS[(fmt, cls)][1]
+        formats.append((fmt, "``sampler(%r, %s)``" % (fmt, usage)))
+    format_str = Table(rows=formats, names=["Format", "Basic usage"]).pformat(
+        max_lines=-1, max_width=80, align=(">", "<")
+    )
+    format_str[1] = format_str[1].replace("-", "=")
+    format_str.insert(0, format_str[1])
+    format_str.append(format_str[0])
+
+    lines.extend([" " * indent + line for line in [header, ""] + format_str])
+    # and overwrite the docstring
+    try:
+        sampler.__doc__ = "\n".join(lines)
+    except AttributeError:
+        sampler.__func__.__doc__ = "\n".join(lines)

cosmic/test_evolve.py

@@ -0,0 +1,108 @@
+"""Unit test for cosmic
+"""
+
+__author__ = 'Katie Breivik <katie.breivik@gmail.com>'
+
+import os
+import unittest
+import numpy as np
+import pandas as pd
+
+from cosmic.evolve import Evolve
+from cosmic.sample.initialbinarytable import InitialBinaryTable
+from cosmic.sample import initialbinarytable
+from cosmic import evolve
+
+import warnings
+warnings.filterwarnings("ignore")
+
+TEST_DATA_DIR = os.path.join(os.path.split(__file__)[0], 'data')
+PARAMS_INI = os.path.join(TEST_DATA_DIR,'Params.ini')
+INIT_CONDITIONS = pd.read_hdf(os.path.join(TEST_DATA_DIR, 'initial_conditions_for_testing.hdf5'), key='initC')
+KICK_INITC = pd.read_hdf(os.path.join(TEST_DATA_DIR, 'kick_initial_conditions.h5'), key='initC')
+
+init_conds_columns = initialbinarytable.INITIAL_CONDITIONS_COLUMNS_ALL
+
+INIT_CONDITIONS_NO_BSE_COLUMNS = INIT_CONDITIONS[init_conds_columns]
+BPP_DF = pd.read_hdf(os.path.join(TEST_DATA_DIR, 'unit_tests_results.hdf5'), key='bpp')
+BCM_DF = pd.read_hdf(os.path.join(TEST_DATA_DIR, 'unit_tests_results.hdf5'), key='bcm')
+BSEFlag_columns = list(set(evolve.INITIAL_BINARY_TABLE_SAVE_COLUMNS) - set(initialbinarytable.INITIAL_CONDITIONS_COLUMNS_ALL)) 
+BSEDict = INIT_CONDITIONS[BSEFlag_columns].to_dict(orient='index')[0]
+BSEDict['qcrit_array'] = [0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0]
+BSEDict['natal_kick_array'] = [[-100.0,-100.0,-100.0,-100.0,0.0], [-100.0,-100.0,-100.0,-100.0,0.0]]
+BSEDict['fprimc_array'] = [2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,
+                           2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,
+                           2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0,2.0/21.0]
+BSEDict['grflag'] = 1
+BSEDict['don_lim'] = -1
+BSEDict['acc_lim'] = -1
+BSEDict['wd_mass_lim'] = 0
+BSEDict['kick_flag'] = -1
+
+class TestEvolve(unittest.TestCase):
+    """`TestCase` for the cosmic
+    """
+    def test_single_evolve_with_table(self):
+
+        # Check that the sample_primary function samples mass correctly
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS, randomseed=523574)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_single_evolve_with_dict(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS_NO_BSE_COLUMNS, BSEDict=BSEDict, randomseed=523574)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_single_evolve_with_inifile(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS_NO_BSE_COLUMNS, params=PARAMS_INI, randomseed=523574)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_single_evolve_with_dict_and_table(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS, BSEDict=BSEDict, randomseed=523574)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_multi_evolve_with_table(self):
+        # Check that the sample_primary function samples mass correctly
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS, n_per_block=100)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_multi_evolve_with_dict(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS_NO_BSE_COLUMNS, BSEDict=BSEDict, randomseed=523574, n_per_block=100)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_multi_evolve_with_inifile(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS_NO_BSE_COLUMNS, params=PARAMS_INI, randomseed=523574, n_per_block=100)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_multi_evolve_with_dict_and_table(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=INIT_CONDITIONS, BSEDict=BSEDict, randomseed=523574, n_per_block=100)
+
+        pd.testing.assert_frame_equal(EvolvedBinaryBPP, BPP_DF, check_dtype=False, check_exact=False)
+        pd.testing.assert_frame_equal(EvolvedBinaryBCM, BCM_DF, check_dtype=False, check_exact=False)
+
+    def test_ejection_velocity_pfahl(self):
+        EvolvedBinaryBPP, EvolvedBinaryBCM, initCond, kick_info = Evolve.evolve(
+            initialbinarytable=KICK_INITC)
+
+        self.assertAlmostEqual(kick_info['vsys_2_total'].iloc[0], 482.346136, places=5)

cosmic/test_match.py

@@ -0,0 +1,30 @@
+"""Unit test for cosmic
+"""
+
+__author__ = 'Katie Breivik <katie.breivik@gmail.com>'
+
+import os
+import unittest
+import numpy as np
+import scipy.integrate
+import pandas as pd
+
+from cosmic import Match
+
+np.random.seed(2)
+sample = np.random.uniform(0,1,500)
+
+MATCH_TEST = np.log10(1-0.99636185870762237007)
+
+class TestMatch(unittest.TestCase):
+    """`TestCase` for the match method
+    """
+    def test_Match(self):
+        # test the match by dividing the sample into to sub samples
+        # one containing half of the set and one containing the full set
+
+        dataCm = [sample[:int(len(sample)/2)], sample]
+        match, bin_width = Match.match(dataCm)
+        self.assertAlmostEqual(match,MATCH_TEST)
+
+