scri
Python/numba code for manipulating time-dependent functions of spin-weighted spherical harmonics on future null infinity
Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README -
✓Academic publication links
Links to: arxiv.org, aps.org, zenodo.org -
✓Committers with academic emails
2 of 13 committers (15.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.9%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Python/numba code for manipulating time-dependent functions of spin-weighted spherical harmonics on future null infinity
Basic Info
Statistics
- Stars: 20
- Watchers: 3
- Forks: 24
- Open Issues: 8
- Releases: 29
Topics
Metadata Files
README.md
Scri
Python/numba code for manipulating time-dependent functions of spin-weighted spherical harmonics on future null infinity
Citing this code
If you use this code for academic work (I can't actually imagine any other use for it), please cite the latest version that you used in your publication. The DOI is:
Also please cite the papers for/by which it was produced:
- "Angular velocity of gravitational radiation from precessing binaries and the corotating frame", Boyle, Phys. Rev. D, 87, 104006 (2013).
- "Gravitational-wave modes from precessing black-hole binaries", Boyle et al., http://arxiv.org/abs/1409.4431 (2014).
- "Transformations of asymptotic gravitational-wave data", Boyle, Phys. Rev. D, 93, 084031 (2015).
Bibtex entries for these articles can be found here. It might also be nice of you to provide a link directly to this source code.
Quick start
Note that installation is not possible on Windows due to missing FFTW support.
Installation is as simple as
sh
conda install -c conda-forge scri
or
sh
python -m pip install scri
If the latter command complains about permissions, you're probably using your
operating system's version of python, which can cause serious conflicts with
essential OS functions. To avoid these issues,
install conda/mamba.
This will create a separate copy of python inside your home directory (avoiding
issues with permissions) which you can update independently of your OS.
Then, in python, you can check to make sure installation worked with
python
import scri
w = scri.WaveformModes()
Note that scri can take a few seconds to import the first time as it compiles
some code automatically. Here, w is an object to contain time and waveform
data, as well as various related pieces of information -- though it is trivial
in this case, because we haven't given it any data. For more information, see
the docstrings of scri, scri.WaveformModes, etc.
Documentation
Tutorials and automatically generated API documentation are available on Read the Docs: scri.
Acknowledgments
Every change to this code is recompiled automatically, bundled into a
conda package, and made available for download from
anaconda.org.
The work of creating this code was supported in part by the Sherman Fairchild Foundation and by NSF Grants No. PHY-1306125 and AST-1333129.
Owner
- Name: Mike Boyle
- Login: moble
- Kind: user
- Location: Ithaca, NY
- Company: Cornell University
- Website: black-holes.org
- Repositories: 76
- Profile: https://github.com/moble
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Boyle" given-names: "Michael" orcid: "https://orcid.org/0000-0002-5075-5116" - family-names: "Iozzo" given-names: "Dante" orcid: "https://orcid.org/0000-0002-7244-1900" - family-names: "Stein" given-names: "Leo" orcid: "https://orcid.org/0000-0001-7559-9597" - family-names: "Khairnar" given-names: "Aniket" orcid: "https://orcid.org/0000-0001-5138-572X" - family-names: "Rüter" given-names: "Hannes" orcid: "https://orcid.org/0000-0002-3442-5360" - family-names: "Scheel" given-names: "Mark" orcid: "https://orcid.org/0000-0001-6656-9134" - family-names: "Varma" given-names: "Vijay" orcid: "https://orcid.org/0000-0002-9994-1761" - family-names: "Mitman" given-names: "Keefe" orcid: "https://orcid.org/0000-0003-0276-3856" title: "scri" version: 2024.0.2 doi: 10.5281/zenodo.4041971 date-released: 2025-06-18 url: "https://github.com/moble/scri"
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 2
- Watch event: 2
- Delete event: 2
- Issue comment event: 17
- Push event: 12
- Pull request review event: 12
- Pull request review comment event: 12
- Pull request event: 16
- Fork event: 4
Last Year
- Create event: 4
- Release event: 1
- Issues event: 2
- Watch event: 2
- Delete event: 2
- Issue comment event: 17
- Push event: 12
- Pull request review event: 12
- Pull request review comment event: 12
- Pull request event: 16
- Fork event: 4
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Michael Boyle | m****e@g****m | 228 |
| github-actions | g****s@g****m | 29 |
| Dante Iozzo | d****o@g****m | 26 |
| Leo C. Stein | l****n@g****m | 11 |
| Keefe Mitman | 5****n | 9 |
| Mark Scheel | s****l@t****u | 6 |
| Dante Iozzo | d****m | 5 |
| Aniket Khairnar | a****a@g****u | 3 |
| Ivan Markin | g****t@u****t | 1 |
| Raffi Enficiaud | r****d | 1 |
| Vijay Varma | v****2@g****m | 1 |
| dependabot[bot] | 4****] | 1 |
| hrueter | 4****r | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 24
- Total pull requests: 81
- Average time to close issues: about 2 months
- Average time to close pull requests: about 2 months
- Total issue authors: 9
- Total pull request authors: 15
- Average comments per issue: 1.46
- Average comments per pull request: 2.25
- Merged pull requests: 60
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 3
- Pull requests: 11
- Average time to close issues: 14 days
- Average time to close pull requests: 2 months
- Issue authors: 3
- Pull request authors: 7
- Average comments per issue: 0.33
- Average comments per pull request: 1.55
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 3
Top Authors
Issue Authors
- duetosymmetry (9)
- 10220 (5)
- markscheel (2)
- keefemitman (2)
- moble (2)
- cookgb (1)
- AnujKankani (1)
- dependabot[bot] (1)
- nilsdeppe (1)
- vijayvarma392 (1)
Pull Request Authors
- 10220 (25)
- keefemitman (16)
- duetosymmetry (11)
- moble (11)
- akhairna (7)
- markscheel (7)
- dependabot[bot] (6)
- unkaktus (2)
- nilsdeppe (2)
- dongzesun (2)
- raffienficiaud (1)
- haraldp271 (1)
- hrueter (1)
- cwoodford (1)
- vijayvarma392 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 1,362 last-month
-
Total dependent packages: 4
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 81
- Total maintainers: 1
pypi.org: scri
Time-dependent functions of spin-weighted spherical harmonics on future null infinity
- Homepage: https://github.com/moble/scri
- Documentation: https://scri.readthedocs.io/
- License: The MIT License (MIT) Copyright (c) 2023 Mike Boyle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 2024.0.2
published 8 months ago
Rankings
Maintainers (1)
conda-forge.org: scri
This package collects a number of functions for constructing and manipulating gravitational waveforms, including rotating, determining the angular velocity, finding the co-precessing and co-rotating frames, and applying boosts, translations, and supertranslations.
- Homepage: https://github.com/moble/scri
- License: MIT
-
Latest release: 2022.8.3
published over 3 years ago
Rankings
Dependencies
- h5py
- matplotlib
- numba >=0.49.1
- numpy >=1.7
- numpydoc >=1.0.0
- python 3.10.*
- quaternion >=2019.7.15.12.50.36
- recommonmark >=0.6.0
- scipy
- spherical_functions
- sphinx >=3.1.0
- sphinx_rtd_theme
- spinsfast
- sxs
- coverage 6.4.2 develop
- pytest-cov 3.0.0 develop
- alabaster 0.7.12
- atomicwrites 1.4.1
- attrs 21.4.0
- babel 2.10.3
- black 22.6.0
- certifi 2022.6.15
- charset-normalizer 2.1.0
- click 8.1.3
- colorama 0.4.5
- docutils 0.19
- feedparser 6.0.10
- ghp-import 2.1.0
- h5py 3.7.0
- idna 3.3
- imagesize 1.4.1
- importlib-metadata 4.12.0
- inflection 0.5.1
- iniconfig 1.1.1
- jinja2 3.1.2
- llvmlite 0.39.0
- markdown 3.3.7
- markupsafe 2.1.1
- mergedeep 1.3.4
- mkdocs 1.3.1
- mktheapidocs 0.2.0.post0.dev8
- mypy-extensions 0.4.3
- numba 0.56.0
- numpy 1.22.4
- numpy-quaternion 2022.4.2
- numpydoc 1.4.0
- packaging 21.3
- pandas 1.4.3
- pathspec 0.9.0
- platformdirs 2.5.2
- pluggy 1.0.0
- py 1.11.0
- pygments 2.12.0
- pylatexenc 2.10
- pyparsing 3.0.9
- pytest 7.1.2
- pytest-forked 1.4.0
- python-dateutil 2.8.2
- pytz 2020.5
- pyyaml 6.0
- pyyaml-env-tag 0.1
- quaternionic 1.0.5
- requests 2.28.1
- scipy 1.8.1
- sgmllib3k 1.0.0
- six 1.16.0
- snowballstemmer 2.2.0
- spherical 1.0.11
- spherical-functions 2022.4.1
- sphinx 5.1.1
- sphinxcontrib-applehelp 1.0.2
- sphinxcontrib-devhelp 1.0.2
- sphinxcontrib-htmlhelp 2.0.0
- sphinxcontrib-jsmath 1.0.1
- sphinxcontrib-qthelp 1.0.3
- sphinxcontrib-serializinghtml 1.1.5
- spinsfast 2022.4.1
- sxs 2022.3.5
- tomli 2.0.1
- tqdm 4.61.1
- typing-extensions 4.3.0
- urllib3 1.26.11
- watchdog 2.1.9
- zipp 3.8.1
- black >=22.1 develop
- mkdocs ^1.1.2 develop
- mktheapidocs ^0.2.0 develop
- pytest ^7.0 develop
- pytest-cov >=2.10.1 develop
- h5py ^3
- importlib-metadata ^1.0
- mkdocs ^1.1.2
- mktheapidocs ^0.2.0
- numba >=0.55
- numpy >=1.20
- numpy-quaternion >=2022.4
- python >=3.8,<3.11
- scipy ^1.0
- spherical-functions >=2022.4
- spinsfast >=2022.4
- sxs >=2022.3.4
- tqdm >=4.48.2, <4.61.2
- actions/checkout v2 composite
- actions/create-release latest composite
- actions/setup-python v2 composite
- codecov/codecov-action v2 composite