pybhpt 0.9.10__cp312-cp312-macosx_15_0_x86_64.whl

pybhpt/teuk.py

@@ -0,0 +1,492 @@
+from cybhpt_full import _TeukolskyMode as _TeukolskyModeCython
+
+class TeukolskyMode:
+    """A class for computing Teukolsky modes sourced by a point-particle orbiting in a Kerr background.
+    
+    Parameters
+    ----------
+    s : int
+        The spin weight of the Teukolsky mode.
+    j : int
+        The spheroidal harmonic mode number.
+    m : int
+        The azimuthal harmonic mode number.
+    k : int
+        The polar harmonic mode number.
+    n : int
+        The radial harmonic mode number.
+    geo : KerrGeodesic class instance
+        KerrGeodesic object containing the background motion of the point-particle source.
+    auto_solve : bool, optional
+        If True, the Teukolsky equation is automatically solved upon initialization. Default is False
+
+    Attributes
+    ----------
+    spinweight : int
+        The spin weight of the Teukolsky mode.
+    spheroidalmode : int
+        The spheroidal harmonic mode number.
+    azimuthalmode : int
+        The azimuthal harmonic mode number.
+    radialmode : int
+        The radial harmonic mode number.
+    polarmode : int
+        The polar harmonic mode number.
+    blackholespin : float
+        The spin of the black hole in the Kerr background.
+    frequency : float
+        The frequency of the Teukolsky mode.
+    horizonfrequency : float
+        The frequency of the mode at the horizon.
+    eigenvalue : float
+        The spheroidal eigenvalue of the Teukolsky mode.
+    mincouplingmode : int
+        The minimum l-mode used for coupling the spherical and spheroidal harmonics
+    maxcouplingmode : int
+        The maximum l-mode used for coupling the spherical and spheroidal harmonics
+    j : int
+        Alias for spheroidalmode.
+    m : int
+        Alias for azimuthalmode.
+    k : int
+        Alias for polarmode.
+    n : int
+        Alias for radialmode.
+    omega : float
+        Alias for frequency.
+    a : float
+        Alias for blackholespin.
+    
+    Methods
+    -------
+    solve(geo, method = "AUTO", nsamples = 256, teuk = None, swsh = None)
+        Solve the Teukolsky equation for the given mode and geodesic.
+    flipspinweight()
+        Flip the spin weight of the Teukolsky mode.
+    flipspinweightandfrequency()
+        Flip the spin weight and frequency of the Teukolsky mode.
+    couplingcoefficient(l)
+        Compute the coupling coefficient for the given l-mode.
+    radialpoint(pos)
+        Compute the radial point for the given position.
+    radialsolution(bc, pos)
+        Compute the radial solution for the given boundary condition and position.
+    radialderivative(bc, pos)
+        Compute the radial derivative for the given boundary condition and position.
+    radialderivative2(bc, pos)
+        Compute the second radial derivative for the given boundary condition and position.
+    homogeneousradialsolution(bc, pos)
+        Compute the homogeneous radial solution for the given boundary condition and position.
+    homogeneousradialderivative(bc, pos)
+        Compute the homogeneous radial derivative for the given boundary condition and position.
+    homogeneousradialderivative2(bc, pos)
+        Compute the second homogeneous radial derivative for the given boundary condition and position.
+    polarpoint(pos)
+        Compute the polar point for the given position.
+    polarsolution(pos)
+        Compute the polar solution for the given position.
+    polarderivative(pos)
+        Compute the polar derivative for the given position.
+    polarderivative2(pos)
+        Compute the second polar derivative for the given position.
+    amplitude(bc)
+        Compute the Teukolsky amplitude for the given boundary condition.
+    precision(bc)
+        Compute the precision of the Teukolsky amplitude for the given boundary condition.
+    """
+    def __init__(self, s, j, m, k, n, geo, auto_solve = False):
+        self.base = _TeukolskyModeCython(s, j, m, k, n, geo.base)
+        if auto_solve:
+            self.solve(geo)
+
+    @property
+    def spinweight(self):
+        return self.base.spinweight
+
+    @property
+    def spheroidalmode(self):
+        return self.base.spheroidalmode
+    
+    @property
+    def azimuthalmode(self):
+        return self.base.azimuthalmode
+
+    @property
+    def radialmode(self):
+        return self.base.radialmode
+
+    @property
+    def polarmode(self):
+        return self.base.polarmode
+
+    @property
+    def blackholespin(self):
+        return self.base.blackholespin
+    
+    @property
+    def frequency(self):
+        return self.base.frequency
+
+    @property
+    def horizonfrequency(self):
+        return self.base.horizonfrequency
+
+    @property
+    def eigenvalue(self):
+        return self.base.eigenvalue
+
+    @property
+    def mincouplingmode(self):
+        return self.base.mincouplingmode
+    
+    @property
+    def maxcouplingmode(self):
+        return self.base.maxcouplingmode
+
+    # some useful aliases
+    @property
+    def j(self):
+        return self.spheroidalmode
+    @property
+    def m(self):
+        return self.azimuthalmode
+    @property
+    def k(self):
+        return self.polarmode
+    @property
+    def n(self):
+        return self.radialmode
+    @property
+    def omega(self):
+        return self.frequency
+    @property
+    def a(self):
+        return self.blackholespin
+    
+    @property
+    def couplingcoefficients(self):
+        return self.base.couplingcoefficients
+    
+    @property
+    def polarpoints(self):
+        return self.base.polarpoints
+    
+    @property
+    def polarsolutions(self):
+        return self.base.polarsolutions
+    
+    @property
+    def polarderivatives(self):
+        return self.base.polarderivatives
+    
+    @property
+    def polarderivatives2(self):
+        return self.base.polarderivatives2
+    
+    @property
+    def radialpoints(self):
+        return self.base.radialpoints
+    
+    @property
+    def radialsolutions(self):
+        return self.base.radialsolutions
+    
+    @property
+    def radialderivatives(self):
+        return self.base.radialderivatives
+    
+    @property
+    def radialderivatives2(self):
+        return self.base.radialderivatives2
+    
+    @property
+    def homogeneousradialsolutions(self):
+        return self.base.homogeneousradialsolutions
+    
+    @property
+    def homogeneousradialderivatives(self):
+        return self.base.homogeneousradialderivatives
+    
+    @property
+    def homogeneousradialderivatives2(self):
+        return self.base.homogeneousradialderivatives2
+    
+    @property
+    def amplitudes(self):
+        return self.base.teukolsky_amplitudes
+    
+    @property
+    def precisions(self):
+        return self.base.teukolsky_amplitude_precisions
+    
+    def solve(self, geo, method = "AUTO", nsamples = 256, teuk = None, swsh = None):
+        """Solve the Teukolsky equation for the given mode and geodesic.
+        Parameters
+        ----------
+        geo : KerrGeodesic class instance
+            KerrGeodesic object containing the background motion of the point-particle source.
+        method : str, optional
+            The method to use for solving the Teukolsky equation. Default is "AUTO".
+        nsamples : int, optional
+            The number of samples to use for the solution. Default is 256.
+        teuk : RadialTeukolsky, optional
+            RadialTeukolsky object to use for constructing the radial Green function. Default is None.
+        swsh : SpheroidalHarmonicMode, optional
+            SpheroidalHarmonic object to use for coupling with spheroidal harmonics. Default is None.
+
+        """
+        if teuk is None or swsh is None:
+            self.base.solve(geo.base, method, nsamples)
+        else:
+            self.base.solve(geo.base, method, nsamples, teuk.base, swsh.base)
+
+    """
+    Flips the spin-weight of the Teukolsky solutions from :math:`s \rightarrow -s`
+    """
+    def flipspinweight(self):
+        self.base.flip_spinweight()
+
+    """
+    Flips the spin-weight and frequency of the Teukolsky solutions from :math:`s \rightarrow -s` and :math:`\omega \rightarrow -\omega`
+    """
+    def flipspinweightandfrequency(self):
+        """
+        Flips the spin-weight and frequency of the Teukolsky solutions from :math:`s \rightarrow -s` and :math:`\omega \rightarrow -\omega`
+        """
+        self.base.flip_spinweight_frequency()
+
+    def couplingcoefficient(self, l):
+        """
+        Spherical-spheroidal mixing coefficient between a spherical harmonic $l$ mode with a spheroidal $j$ mode.
+        
+        Parameters
+        ----------
+        l : int
+            Spherical harmonic mode.
+
+        Returns
+        -------
+        float
+            The coupling coefficient between the spherical harmonic mode `l` and the spheroidal harmonic mode `j`.
+        """
+        return self.base.couplingcoefficient(l)
+
+    def radialpoint(self, pos):
+        """
+        The radial point for the given position `pos`.
+
+        Parameters
+        ----------
+        pos : int
+            The radial position.
+        
+        Returns
+        -------
+        float
+            The radial point at the given position `pos`.
+        """
+        return self.base.radialpoint(pos)
+    
+    def radialsolution(self, bc, pos):
+        """
+        The extended homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial solution at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.radialsolution(bc, pos)
+    
+    def radialderivative(self, bc, pos):
+        """
+        The derivative of the extended homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial derivative at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.radialderivative(bc, pos)
+    
+    def radialderivative2(self, bc, pos):
+        """
+        The second derivative of the extended homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial second derivative at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.radialderivative2(bc, pos)
+    
+    def homogeneousradialsolution(self, bc, pos):
+        """
+        The homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial solution at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.homogeneousradialsolution(bc, pos)
+    
+    def homogeneousradialderivative(self, bc, pos):
+        """
+        The radial derivative of the homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial derivative at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.homogeneousradialderivative(bc, pos)
+    
+    def homogeneousradialderivative2(self, bc, pos):
+        """
+        The second radial derivative of the homogeneous radial solution for the given boundary condition `bc` and position `pos`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+        pos : int
+            The radial position.
+
+        Returns
+        -------
+        complex
+            The radial second derivative at the given boundary condition `bc` and position `pos`.
+        """
+        return self.base.homogeneousradialderivative2(bc, pos)
+    
+    def polarpoint(self, pos):
+        """
+        The polar point for the given position `pos`.
+
+        Parameters
+        ----------
+        pos : int
+            The polar position.
+
+        Returns
+        -------
+        float
+            The polar point at the given position `pos`.
+        """
+        return self.base.polarpoint(pos)
+    
+    def polarsolution(self, pos):
+        """
+        The polar solution for the given position `pos`.
+
+        Parameters
+        ----------
+        pos : int
+            The polar position.
+
+        Returns
+        -------
+        float
+            The polar solution at the given position `pos`.
+        """
+        return self.base.polarsolution(pos)
+    
+    def polarderivative(self, pos):
+        """
+        The derivative of the polar solution for the given position `pos`.
+
+        Parameters
+        ----------
+        pos : int
+            The polar position.
+
+        Returns
+        -------
+        float
+            The polar derivative at the given position `pos`.
+        """
+        return self.base.polarderivative(pos)
+    
+    def polarderivative2(self, pos):
+        """
+        The second derivative of the polar solution for the given position `pos`.
+
+        Parameters
+        ----------
+        pos : int
+            The polar position.
+        
+        Returns
+        -------
+        float
+            The polar second derivative at the given position `pos`.
+        """
+        return self.base.polarderivative2(pos)
+    
+    def amplitude(self, bc):
+        """
+        The Teukolsky amplitude for the given boundary condition `bc`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+
+        Returns
+        -------
+        complex
+            The Teukolsky amplitude at the given boundary condition `bc`.
+        """
+        return self.base.teukolsky_amplitude(bc)
+    
+    def precision(self, bc):
+        """
+        The precision of the Teukolsky amplitude for the given boundary condition `bc`.
+
+        Parameters
+        ----------
+        bc : str
+            The boundary condition, either "In" for ingoing or "Up" for upgoing.
+
+        Returns
+        -------
+        float
+            The precision of the Teukolsky amplitude at the given boundary condition `bc`.
+        """
+        return self.base.teukolsky_amplitude_precision(bc)

pybhpt-0.9.10.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.2
+Name: pybhpt
+Version: 0.9.10
+Summary: Black Hole Perturbation Theory and Self-Force Algorithms in Python
+Author-Email: Zach Nasipak <znasipak@gmail.com>
+License: GPL
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: C++
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Natural Language :: English
+Project-URL: Github, https://github.com/znasipak/pybhpt
+Project-URL: Bug Tracker, https://github.com/znasipak/pybhpt/issues
+Requires-Python: >=3.8
+Requires-Dist: numpy<=2.2
+Requires-Dist: scipy
+Provides-Extra: testing
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Provides-Extra: dev
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Provides-Extra: extended
+Requires-Dist: pandas; extra == "extended"
+Requires-Dist: spherical; extra == "extended"
+Requires-Dist: tqdm; extra == "extended"
+Description-Content-Type: text/markdown
+
+# pybhpt
+
+A python package for solving problems in black hole perturbation theory. 
+
+`pybhpt` is a collection of numerical tools for analyzing perturbations of Kerr spacetime, particularly the self-forces and metric-perturbations experienced by small bodies moving in a Kerr background. Subpackages include: 
+
+- `pybhpt.geodesic`: a module that generates bound periodic timelike geodesics in Kerr spacetime
+- `pybhpt.radial`: a module that calculates homogeneous solutions of the radial Teukolsky equation
+- `pybhpt.swsh`: a module that constructs the spin-weighted spheroidal harmonics
+- `pybhpt.teuk`: a module that evaluates the inhomogeneous solutions (Teukolsky amplitudes) of the radial Teukolsky equation due to a point-particle on a bound timelike Kerr geodesic
+- `pybhpt.flux`: a module that produces the gravitational wave fluxes sourced by a point-particle on a generic bound timelike Kerr geodesic
+- `pybhpt.hertz`: a module that solves for the Hertz potentials for the CCK and AAB metric reconstruction procedures
+- `pybhpt.metric`: a module that produces the coefficients needed to reconstruct the metric from the Hertz potentials
+- `pybhpt.redshift`: a module that computes the generalized Detweiler redshift invariant in a variety of gauges
+
+See the [Documentation](https://pybhpt.readthedocs.io/en/latest/) pages for more information about the package, including User Guides and API. References and author information can be found at the bottom of the README.
+
+## Quick Installation
+
+Tagged releases of `pybhpt` are available as wheel packages for macOS and 64-bit Linux on [PyPI](https://pypi.org/project/pybhpt). Install using `pip`:
+```
+python3 -m pip install pybhpt
+```
+
+## Developer Installation
+
+`pybhpt` relies on several dependencies to install and run, namely a C/C++ compiler (e.g., `g++`), `gsl`, `boost`, `Cython`, `numpy`, `scipy`, and `python >= 3.8`. To reduce package conflicts and ensure that the proper dependencies are installed, we recommend using [conda](https://docs.conda.io/en/latest/) (paricularly through [Miniforge](https://github.com/conda-forge/miniforge)) and its virtual environments.
+
+To create a conda environment `pybhpt-env` with just the necessary dependencies use `environment.yml`:
+```
+conda env create -f environment.yml
+conda activate pybhpt-env
+```
+For an environment with the extended recommended software dependencies, one can replace `environment.yml` with `environment-extended.yml` or follow the extended `pip` install instructions below. 
+
+Next clone the `pybhpt` repository from GitHub:
+```
+git clone https://github.com/znasipak/pybhpt.git
+cd pybhpt
+```
+The `boost` repository is included as a submodule under `extern/boost`. To activate the submodule:
+```
+git submodule update --init --recursive extern/boost
+```
+To include the Boost headers in the compilation path:
+```
+cd extern/boost
+chmod +x bootstrap.sh
+./bootstrap.sh
+./b2 headers
+```
+Finally, we recommend installing the package via `pip`:
+```
+pip install .
+```
+or to get the basic development dependencies:
+```
+pip install '.[dev, testing]'
+```
+To get all recommended software:
+```
+pip install '.[dev, testing, extended]'
+```
+To ensure the package installed properly, run the unit tests via `pytest`:
+```
+pytest .
+```
+
+## Conda Environments with Jupyter
+
+To run the code in a Jupyter notebook, we recommend `pip` installing the following dependencies:
+```
+pip install ipykernel matplotlib
+```
+These dependencies are already included in `environment-extended.yml` or in the optional `pip install` dependencies. To make the environment accessible within Jupyter:
+```
+python -m ipykernel install --user --name=pybhpt-env
+```
+
+## Uninstalling
+
+If the package is installed using `pip`, then one can easily uninstall the package by executing
+```
+pip uninstall pybhpt
+```
+Developers may also need to remove the directories `build/` and `pybhpt.egg.info/` from the main repository.
+
+## Troubleshooting compiling from source
+
+If there are problems compiling `pybhpt` from source, it may be because `cmake` cannot identify the correct compiler. To fix this issue, one can try to explicitly download the necessary compiler into their conda environment.
+
+To include the necessary compiler on macOS Intel:
+```
+conda install clang_osx-64 clangxx_osx-64
+```
+To include the necessary compiler on macOS arm/silicon:
+```
+conda install clang_osx-arm64 clangxx_osx-arm64
+```
+To include the necessary compiler on Linux:
+```
+conda install gcc_linux-64 gxx_linux-64
+```
+
+## References
+
+Theoretical background for the code and explanations of the numerical methods used within are summarized in the references below: 
+
+- Z. Nasipak, *Metric reconstruction and the Hamiltonian for eccentric, precessing binaries in the small-mass-ratio limit* (2025) [arXiv:2507.07746](https://arxiv.org/abs/2507.07746)
+- Z. Nasipak, *An adiabatic gravitational waveform model for compact objects undergoing quasi-circular inspirals into rotating massive black holes*, Phys. Rev. D 109, 044020 (2024) [arXiv:2310.19706](https://arxiv.org/abs/2310.19706)
+- Z. Nasipak, *Adiabatic evolution due to the conservative scalar self-force during orbital resonances*, Phys. Rev. D 106, 064042 (2022) [arXiv:2207.02224](https://arxiv.org/abs/2207.02224)
+
+## Authors
+
+Zachary Nasipak
+
+## Contributors
+
+Zachary Nasipak
+
+Christian Chapman-Bird

pybhpt-0.9.10.dist-info/RECORD

@@ -0,0 +1,16 @@
+cybhpt_full.cpython-312-darwin.so,sha256=rY1QfcVMUfAM_SvTQiwWMZM_apr_0HG6Z3ZUdd8hPu0,2360944
+pybhpt-0.9.10.dist-info/RECORD,,
+pybhpt-0.9.10.dist-info/WHEEL,sha256=bzH17ccJ1joRkQvwNza4T9UCzNV6eCuH71N8yWxKq_E,142
+pybhpt-0.9.10.dist-info/METADATA,sha256=D3HVza1Dw0AenIHPUyrAYICu3RhX3Pv2X79JY50tqR0,6427
+pybhpt-0.9.10.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+pybhpt/geo.py,sha256=PbRr_-KGthdDmhwEqiV69PX9ljnNjvYneKQWCBe8jWs,30534
+pybhpt/redshift.py,sha256=eWQ9jGctxOOyOowP5BdBdnln3HdpQLubApDBFKoCL1Y,794
+pybhpt/hertz.py,sha256=kLwiU_AAEzMMIKn3EI3KNg1y1bScZxC_F5n77VKMulc,13585
+pybhpt/radial.py,sha256=6AzGvoyXfhRT1_87Y6fIQQ0EZnx9wO4GtSu3jWzM4Zg,15607
+pybhpt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pybhpt/swsh.py,sha256=rwkjlsDPg_Yx2R8r9d_gv2D1tShgGDqIjGkupiXbmZk,20956
+pybhpt/metric.py,sha256=xS3VXti-qryUIm2pWdroHAkKCV_JQA0pCs_2aDn_Ffk,11917
+pybhpt/teuk.py,sha256=rSo_1ENBt4qt5Ln94Q721FBV52ZCUtAPb20_aRaM9lM,14989
+pybhpt/flux.py,sha256=uRjFHg1clHDN9MofiGS1ra2hGAt4Bv9kGogQ-OpNePY,6068
+pybhpt/.dylibs/libgsl.28.dylib,sha256=LZzQOyyIx4U5-yAVbb_A1lNRXm8BwTToumfsFkzIfsU,2427264
+pybhpt/.dylibs/libgslcblas.0.dylib,sha256=h1FSgXIm1ms4NxAp-R5eJ5IbvCHHK1aWJDAnHhHoL_Q,235616

pybhpt-0.9.10.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.6
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_15_0_x86_64
+Generator: delocate 0.13.0
+