Data

Tools

Indexes

Applications

Experiments

Open Source Science

LEGWORK

LEGWORK: A python package for computing the evolution and detectability of stellar-origin gravitational-wave sources with space-based detectors - Published in JOSS (2022)

https://github.com/teamlegwork/legwork

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ✓
    Academic publication links
    Links to: arxiv.org
  • ✓
    Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

astrophysics gravitational-waves lisa python

Scientific Fields

Mathematics Computer Science - 37% confidence
Last synced: 4 months ago · JSON representation

Repository

Package for making predictions about stellar-origin sources in space-based gravitational wave detectors

Basic Info
Statistics
  • Stars: 44
  • Watchers: 4
  • Forks: 10
  • Open Issues: 1
  • Releases: 28
Topics
astrophysics gravitational-waves lisa python
Created almost 5 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License

README.md

The LISA Evolution and Gravitational Wave ORbit Kit
Read the article Documentation Status ascl:2111.007 Email the authors

A python package that does the LEGWORK for you by evolving binaries, computing signal-to-noise ratios for binary systems potentially observable with LISA and visualising the results.

Installation

Put simply? pip install legwork! But we recommend creating a conda environment first to ensure everything goes smoothly! Check out the installation instructions here to learn exactly how to install LEGWORK

LEGWORK has a couple of dependencies: numpy, astropy, numba, scipy, schwimmbad, matplotlib and seaborn (see requirements.txt for the exact version requirements). These will be installed automatically if you follow the installation instructions!

Documentation

All documentation related to LEGWORK can be found at this link

Other quick links

  • Quickstart - New to LEGWORK? Try out our quickstart tutorial!
  • Tutorials - Learn more about what you can do with LEGWORK with our tutorials!
  • Citing LEGWORK - If you're using LEGWORK for a scientific publication please follow the link for citation intstructions
  • Demos - Want to see what LEGWORK is capable of? Check out our demos!
  • API reference - Wondering how you should use a particular function? Go take a look at our full API reference!
  • Feature requests - Do you have an idea for adding something to LEGWORK? Create an issue here and let us know! Or, even better, make the change yourself and create a pull request!
  • Bug reporting - If you see a bug we would love to know about it! Please create an issue here!
  • Release paper - The LEGWORK release paper is now on the ArXiv and you can also view it directly in GitHub if you prefer!

Owner

  • Name: LEGWORK
  • Login: TeamLEGWORK
  • Kind: organization

JOSS Publication

LEGWORK: A python package for computing the evolution and detectability of stellar-origin gravitational-wave sources with space-based detectors
Published
February 03, 2022
DOI
Volume 7, Issue 70, Page 3998
Authors
Tom Wagg ORCID
Department of Astronomy, University of Washington, Seattle, WA, 98195, Center for Astrophysics | Harvard & Smithsonian, 60 Garden Street, Cambridge, MA 02138, USA, Max-Planck-Institut für Astrophysik, Karl-Schwarzschild-Straße 1, 85741 Garching, Germany
Katelyn Breivik ORCID
Center for Computational Astrophysics, Flatiron Institute, 162 Fifth Ave, New York, NY, 10010, USA
Selma E. de Mink ORCID
Max-Planck-Institut für Astrophysik, Karl-Schwarzschild-Straße 1, 85741 Garching, Germany, Anton Pannekoek Institute for Astronomy and GRAPPA, University of Amsterdam, NL-1090 GE Amsterdam, The Netherlands, Center for Astrophysics | Harvard & Smithsonian, 60 Garden Street, Cambridge, MA 02138, USA
Editor
Arfon Smith ORCID
Tags
astronomy gravitational waves gravitational wave detectors LISA TianQin compact objects orbital evolution white dwarfs neutron stars stellar mass black holes
View PDF Review Thread Software Archive

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 1
  • Issue comment event: 9
  • Push event: 3
  • Pull request event: 7
  • Fork event: 1
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 1
  • Issue comment event: 9
  • Push event: 3
  • Pull request event: 7
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 755
  • Total Committers: 3
  • Avg Commits per committer: 251.667
  • Development Distribution Score (DDS): 0.33
Past Year
  • Commits: 14
  • Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tom Wagg t****g@c****u 506
katiebreivik k****3@u****u 139
Tom Wagg t****g@g****m 110
Committer Domains (Top 20 + Academic)
u.northwestern.edu: 1 college.harvard.edu: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 53
  • Total pull requests: 65
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 19 days
  • Total issue authors: 12
  • Total pull request authors: 4
  • Average comments per issue: 1.79
  • Average comments per pull request: 1.06
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 7
  • Average time to close issues: 12 days
  • Average time to close pull requests: 18 minutes
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.86
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • TomWagg (19)
  • dbkeitel (15)
  • katiebreivik (5)
  • astrokang (3)
  • kayhangultekin (2)
  • AstrophysicsAndPython (2)
  • cmbiwer (2)
  • stegmaja (1)
  • SimraZia (1)
  • Hai-Liang (1)
  • PetraTang (1)
  • Peggy-Guo (1)
Pull Request Authors
  • TomWagg (49)
  • katiebreivik (15)
  • vickerson (2)
  • arfon (1)
Top Labels
Issue Labels
documentation (20) enhancement (14) bug (13) question (4) help wanted (2) good first issue (1) missing example (1) reminder (1)
Pull Request Labels
enhancement (15) bug (13) documentation (11)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 151 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 4
  • Total versions: 30
  • Total maintainers: 2
pypi.org: legwork

A python package to compute gravitational wave evolution and signal to noise ratio calculations for LISA

  • Versions: 30
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 151 Last month
Rankings
Dependent repos count: 7.6%
Dependent packages count: 9.9%
Stargazers count: 10.7%
Average: 11.4%
Forks count: 13.3%
Downloads: 15.3%
Maintainers (2)
katiebreivik tomwagg
Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi
  • IPython *
  • Jinja2 ==2.11
  • ipykernel *
  • markupsafe ==2.0.1
  • nbsphinx >=0.8.6
  • numpydoc *
  • schwimmbad *
  • sphinx-tabs *
  • sphinx_automodapi *
  • sphinx_copybutton *
  • sphinx_rtd_theme *
  • sphinxcontrib.bibtex *
requirements.txt pypi
  • Jinja2 ==2.11
  • astropy >=4.0
  • matplotlib >=3.3.2
  • numba >=0.50
  • numpy >=1.16
  • schwimmbad >=0.3.2
  • scipy >=1.5.0
  • seaborn >=0.11.1
.github/workflows/pypi_upload.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-package.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • orgoro/coverage v3.2 composite
pyproject.toml pypi
setup.py pypi
environment.yml conda
  • astropy >=6.1
  • ipython
  • jupyter
  • matplotlib >=3.8
  • numba >=0.58
  • numpy >=1.26
  • pip >=24.0
  • python >=3.11
  • schwimmbad >=0.4.2
  • scipy >=1.13
  • seaborn >=0.13.2