pybhpt 0.9.4__cp38-cp38-macosx_14_0_arm64.whl

pybhpt-0.9.4.dist-info/METADATA

@@ -0,0 +1,135 @@
+Metadata-Version: 2.2
+Name: pybhpt
+Version: 0.9.4
+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 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
+
+## Quick Installation
+
+Tagged releases of `pybhpt` are available as wheel packages for macOS and 64-bit Linux on [PyPI](https://pypi.org/project/matplotlib/). 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
+```
+
+## Authors
+
+Zachary Nasipak

pybhpt-0.9.4.dist-info/RECORD

@@ -0,0 +1,16 @@
+cybhpt_full.cpython-38-darwin.so,sha256=fL8CCr6JTXuj9TCnOD7Cyy2go7sM2C4kutEXte19XSg,1784880
+pybhpt/geo.py,sha256=QyiwlXF0cIYSpkV7wC9-ITd2bqIumvXiIt2_uNlhJMc,12237
+pybhpt/redshift.py,sha256=ozDDbkv34FQ_Op3FotmHJ-J5Vfy2oF4_Ri1HRujnzAY,791
+pybhpt/hertz.py,sha256=9atjscxbR7eszsY6BuJvcy0PqlgMFwYI23kUIn4mUwc,13565
+pybhpt/radial.py,sha256=2H3rH4XczAVCbKveHmPO2wt3w8ApPZYWCAwkwnxPnps,13995
+pybhpt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pybhpt/swsh.py,sha256=WjtpHNZ6c7RVxuml1I6_cEu8D6cb4hD6aiHZVwD7AeA,10462
+pybhpt/metric.py,sha256=y8ip24rFto7m7rZb0-fuYMrYUmbCzInaWQVYJRI3m3o,11971
+pybhpt/teuk.py,sha256=w3tcidkaOGeywZPqjggacYhxaFxgsxXdMlJ2C7TwdMQ,8220
+pybhpt/flux.py,sha256=2ahStjbsswsWMNPfDiOlQIrzulJZrhaqoDENC0bCLE4,4299
+pybhpt/.dylibs/libgsl.28.dylib,sha256=57NeYzXRx_Fvr8ChQggQOBqCgqn5xXxWyFIiGMm3-_M,2241424
+pybhpt/.dylibs/libgslcblas.0.dylib,sha256=FuXGrQKlT1nkAMaRH6O1B_CnRFFX4pqVcK36KX_-56A,239760
+pybhpt-0.9.4.dist-info/RECORD,,
+pybhpt-0.9.4.dist-info/WHEEL,sha256=NR48bMiVINOK5RoUvmfb-l9oVk-Sz9oMtH3mccOQJIY,112
+pybhpt-0.9.4.dist-info/METADATA,sha256=EMPVuX-dje_Xt0axnmQHVeuax7rV66-dPzXO0_92ehc,5386
+pybhpt-0.9.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149

pybhpt-0.9.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.5
+Root-Is-Purelib: false
+Tag: cp38-cp38-macosx_14_0_arm64
+