{"id":32175848,"url":"https://github.com/vijayvarma392/surfinbh","last_synced_at":"2026-03-04T18:31:51.146Z","repository":{"id":45217740,"uuid":"145179417","full_name":"vijayvarma392/surfinBH","owner":"vijayvarma392","description":"Surrogate Final BH properties","archived":false,"fork":false,"pushed_at":"2025-07-21T14:25:15.000Z","size":3264,"stargazers_count":23,"open_issues_count":6,"forks_count":13,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-21T19:49:34.195Z","etag":null,"topics":["blackholes","gaussian-process-regression","gravitational-waves","physics"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vijayvarma392.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-18T01:10:51.000Z","updated_at":"2025-07-21T14:25:19.000Z","dependencies_parsed_at":"2025-03-09T22:22:07.620Z","dependency_job_id":"b5aa37cf-de2b-41c4-bb65-1c00125b1821","html_url":"https://github.com/vijayvarma392/surfinBH","commit_stats":{"total_commits":269,"total_committers":4,"mean_commits":67.25,"dds":"0.14869888475836435","last_synced_commit":"06bec098ee24dce073d548daf61a140a005e9b0c"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/vijayvarma392/surfinBH","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vijayvarma392%2FsurfinBH","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vijayvarma392%2FsurfinBH/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vijayvarma392%2FsurfinBH/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vijayvarma392%2FsurfinBH/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vijayvarma392","download_url":"https://codeload.github.com/vijayvarma392/surfinBH/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vijayvarma392%2FsurfinBH/sbom","scorecard":{"id":921379,"data":{"date":"2025-08-11","repo":{"name":"github.com/vijayvarma392/surfinBH","commit":"68d6fe64824a2aa3d5ad987420b6dcd829efccd2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.4,"checks":[{"name":"Code-Review","score":3,"reason":"Found 6/19 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":6,"reason":"7 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/vijayvarma392/surfinBH/test.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/vijayvarma392/surfinBH/test.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/vijayvarma392/.github/SECURITY.md:1","Info: Found linked content: github.com/vijayvarma392/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/vijayvarma392/.github/SECURITY.md:1","Info: Found text in security policy: github.com/vijayvarma392/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-25T03:34:21.713Z","repository_id":45217740,"created_at":"2025-08-25T03:34:21.713Z","updated_at":"2025-08-25T03:34:21.713Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280325299,"owners_count":26311419,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blackholes","gaussian-process-regression","gravitational-waves","physics"],"created_at":"2025-10-21T19:50:07.505Z","updated_at":"2025-10-21T19:50:12.068Z","avatar_url":"https://github.com/vijayvarma392.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![github](https://img.shields.io/badge/GitHub-surfinBH-blue.svg)](https://github.com/vijayvarma392/surfinBH)\n[![PyPI version](https://badge.fury.io/py/surfinBH.svg)](https://pypi.org/project/surfinBH/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/surfinbh.svg)](https://anaconda.org/conda-forge/surfinbh)\n[![DOI](https://zenodo.org/badge/145179417.svg)](https://zenodo.org/badge/latestdoi/145179417)\n[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vijayvarma392/surfinBH/blob/master/LICENSE)\n[![Build Status](https://github.com/vijayvarma392/surfinBH/actions/workflows/test.yml/badge.svg)](https://github.com/vijayvarma392/surfinBH/actions/workflows/test.yml)\n\n\n# Welcome to surfinBH!\n\n\u003cimg src=\"https://raw.githubusercontent.com/vijayvarma392/surfinBH/master/images/interaction.jpeg\" alt=\"BHScattering\" width=\"600px\"/\u003e\n\n\u003cbr/\u003e\n\n_**surfinBH**_ provides _**sur**rogate **fin**al **B**lack_ _**H**ole_\nproperties for mergers of binary black holes (BBH).\n\nThese fits are described in the following papers: \u003cbr/\u003e\n[1] V. Varma, D. Gerosa, L. C. Stein, F. Hébert and H. Zhang,\n[arxiv:1809.09125](https://arxiv.org/abs/1809.09125).\n\n[2] V. Varma, S. E. Field, M. A. Scheel, J. Blackman, D. Gerosa, L. C.\nStein, L. E. Kidder, H. P. Pfeiffer,\n[arxiv:1905.09300](https://arxiv.org/abs/1905.09300).\n\n[3] M. Boschini, D. Gerosa, V. Varma, et al.,\n[arXiv:2307.03435](https://arxiv.org/abs/2307.03435)\n\n[4] L. Magaña Zertuche, L. C. Stein, et al.,\n[arXiv:2408.05300](https://arxiv.org/abs/2408.05300)\n\n[5] G. Da Re, K. Mitman, L. C. Stein, et al.,\n[arXiv:2503.09569](https://arxiv.org/abs/2503.09569)\n\nIf you find this package useful in your work, please cite reference [1] and,\nif available, the relevant paper describing the particular model. Please also\ncite this package, see the DOI badge at the top of this page for BibTeX keys.\n\nThis package lives on [GitHub](https://github.com/vijayvarma392/surfinBH), is\ncompatible with `python3`, and is tested every week. You can see the current\nbuild status of the master branch at the top of this page.\n\n## Installation\n\n### PyPI\n_**surfinBH**_ is available through [PyPI](https://pypi.org/project/surfinBH/):\n\n```shell\npip install surfinBH\n```\n\n### Conda\n_**surfinBH**_ is available on [conda-forge](https://anaconda.org/conda-forge/surfinbh):\n\n```shell\nconda install -c conda-forge surfinbh\n```\n\n\n### From source\n\n```shell\ngit clone git@github.com:vijayvarma392/surfinBH.git\ncd surfinBH\ngit submodule init\ngit submodule update\npython setup.py install\n```\n\nIf you do not have root permissions, replace the last step with\n`python setup.py install --user`\n\n\n## Dependencies\nAll of these can be installed through pip or conda.\n* [numpy](https://docs.scipy.org/doc/numpy/user/install.html)\n* [scipy](https://www.scipy.org/install.html)\n* [h5py](http://docs.h5py.org/en/latest/build.html)\n* [scikit-learn](http://scikit-learn.org/stable/install.html) (at least 0.19.1)\n* [lalsuite](https://pypi.org/project/lalsuite) (at least 6.70)\n* [gwsurrogate](https://pypi.org/project/gwsurrogate)\n\n\n## Usage\n\n```python\nimport surfinBH\n```\n\n### See list of available fits\n```python\nprint(list(surfinBH.fits_collection.keys()))\n\u003e\u003e\u003e ['NRSur3dq8Remnant', 'surfinBH7dq2', 'NRSur7dq4Remnant', 'NRSur7dq4EmriRemnant', 'NRSur3dq8_RD', 'NRSur3dq8BMSRemnant']\n```\n\nPick your favorite fit and get some basic information about it.\n```python\nfit_name = 'NRSur7dq4Remnant'\n\nsurfinBH.fits_collection[fit_name].desc\n\u003e\u003e\u003e 'Fits for remnant mass, spin and kick veclocity for generically precessing BBH systems up to mass ratio 4.'\n\nsurfinBH.fits_collection[fit_name].refs\n\u003e\u003e\u003e 'arxiv:1905.09300'\n```\n\n### Load the fit\nThis only needs to be done **once** at the start of your script.\nIf the fit data is not already downloaded, this will also download the data.\n```python\nfit = surfinBH.LoadFits(fit_name)\n\u003e\u003e\u003e Loaded NRSur7dq4Remnant fit.\n```\n### Evaluation\nThe evaluation of each fit is different, so be sure to read the documentation.\nThis also describes the frames in which different quantities are defined.\n```python\nhelp(fit)\n```\n\nWe also provide ipython examples for usage of different fits:\n\n##### Current fits\n\n* [NRSur7dq4Remnant](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_7dq4.ipynb) (Ref. [2])\n\n* [NRSur7dq4EmriRemnant](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_7dq4Emri.ipynb) (Ref. [3])\n\n* [NRSur3dq8Remnant](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_3dq8.ipynb) (called surfinBH3dq8 in Ref. [1])\n\n* [NRSur3dq8_RD](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_3dq8_RD.ipynb) (Ref. [4])\n\n* [NRSur3dq8BMSRemnant](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_3dq8BMS.ipynb) (Ref. [5]) \n\n##### Deprecated fits\n\n* [surfinBH7dq2](https://github.com/vijayvarma392/surfinBH/blob/master/examples/example_7dq2.ipynb) (Ref. [1]. Superseded by NRSur7dq4Remnant)\n\n## Animations\n\nWe also provide a tool to visualize the binary black hole scattering process,\nsee\n[binary black hole explorer](https://vijayvarma392.github.io/binaryBHexp/).\nHere's an example:\n\n\u003cimg src=\"https://raw.githubusercontent.com/vijayvarma392/binaryBHexp/master/animations/video.gif\" width=\"500\"/\u003e\n\n\n## Making contributions\nSee this\n[README](https://github.com/vijayvarma392/surfinBH/blob/master/README_developers.md)\nfor instructions on how to make contributions to this package.\n\n\n\n## Credits\nThe code is maintained by [Vijay Varma](https://vijayvarma.com).\nYou can find the list of contributors\n[here](https://github.com/vijayvarma392/surfinBH/graphs/contributors).\nPlease report bugs by raising an\nissue on our [GitHub](https://github.com/vijayvarma392/surfinBH) repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvijayvarma392%2Fsurfinbh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvijayvarma392%2Fsurfinbh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvijayvarma392%2Fsurfinbh/lists"}