代理最终BH属性。
项目描述
欢迎使用surfinBH！
surfinBH 为双黑洞合并（BBH）提供 代理最终 B黑洞 Hole 属性。
这些拟合在以下论文中描述
[1] V. Varma, D. Gerosa, L. C. Stein, F. Hébert and H. Zhang, arxiv:1809.09125.
[2] V. Varma, S. E. Field, M. A. Scheel, J. Blackman, D. Gerosa, L. C. Stein, L. E. Kidder, H. P. Pfeiffer, arxiv:1905.09300.
[3] M. Boschini, D. Gerosa, V. Varma, et al., arXiv:2307.03435
[4] L. Magaña Zertuche, L. C. Stein, et al., arXiv:2408.05300
如果您在工作中发现此软件包很有用，请引用参考文献[1]以及（如果可用）描述特定模型的有关论文。请还引用此软件包，参见本页顶部的DOI徽章以获取BibTeX密钥。
该软件包位于 GitHub，与 python3 兼容，并且每周都会进行测试。您可以在本页面的顶部查看主分支的当前构建状态。
安装
PyPI
surfinBH 通过 PyPI 提供
pip install surfinBH
Conda
surfinBH 在 conda-forge 上提供
conda install -c conda-forge surfinbh
从源码安装
git clone git@github.com:vijayvarma392/surfinBH.git
cd surfinBH
git submodule init
git submodule update
python setup.py install
如果您没有root权限，将最后一步替换为 python setup.py install --user
依赖项
这些都可以通过pip或conda安装。
- numpy
- scipy
- h5py
- scikit-learn（至少0.19.1版本）
- lalsuite（至少6.70版本）
- gwsurrogate
- NRSur7dq2（仅适用于surfinBH7dq2）
使用方法
import surfinBH
查看可用的fit列表
print(list(surfinBH.fits_collection.keys()))
>>> ['NRSur3dq8Remnant', 'surfinBH7dq2', 'NRSur7dq4Remnant', 'NRSur7dq4EmriRemnant', 'NRSur3dq8_RD']
选择您最喜欢的fit，并获取一些基本信息。
fit_name = 'NRSur7dq4Remnant'
surfinBH.fits_collection[fit_name].desc
>>> 'Fits for remnant mass, spin and kick veclocity for generically precessing BBH systems up to mass ratio 4.'
surfinBH.fits_collection[fit_name].refs
>>> 'arxiv:1905.09300'
加载fit
这只需要在脚本开始时进行一次。如果fit数据尚未下载，此步骤也将下载数据。
fit = surfinBH.LoadFits(fit_name)
>>> Loaded NRSur7dq4Remnant fit.
评估
每个fit的评估方法不同，请务必阅读文档。这也描述了不同量定义的帧。
help(fit)
我们还提供了不同fits使用的ipython示例
当前fits
-
NRSur7dq4Remnant（参考文献[2]）
-
NRSur7dq4EmriRemnant（参考文献[3]）
-
NRSur3dq8Remnant（参考文献[1]中称为surfinBH3dq8）
-
NRSur3dq8_RD（参考文献[4]）
旧版本fits
- surfinBH7dq2（参考文献[1]。已被NRSur7dq4Remnant取代）
动画
我们还提供了一个可视化双黑洞散射过程的工具，请参阅 双黑洞探索器。以下是一个示例
做出贡献
有关如何为此软件包做出贡献的说明，请参阅此 README。
致谢
代码由 Vijay Varma 维护。您可以在此处找到贡献者列表。请通过在我们的GitHub仓库中提出问题来报告错误。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源代码分发
构建分发
surfinBH-1.2.5.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | c1dff91a1d59e04aef5de1d8872cd0c25ae4fbc1a8f36b1b1bc26c8ad79a1028 |
|
| MD5 | 7b0dabdc455a977062aeb4fb4731911b |
|
| BLAKE2b-256 | 8227a1f93bf7afb2ddb43548eec3297301145d0a15a8f4858632773033dbec81 |
surfinBH-1.2.5-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 5f44e6e71d17d9b7b6d620fa8ca45c581316c1bb091176652de2485ddc568b47 |
|
| MD5 | cab128c78599f0a34f3c5da267f84050 |
|
| BLAKE2b-256 | ca91f4b877e7a08b85743bb28f85bec9fe6b81c10972bef58b58e6fcb48ea7de |