Metadata-Version: 2.1
Name: legwork
Version: 0.0.3
Summary: A python package to compute gravitational wave evolution and signal to noise ratio calculations for LISA
Home-page: https://github.com/katiebreivik/gw-calcs
Author: Tom Wagg, Katie Breivik
Author-email: kbreivik@flatironinstitute.org
License: MIT
Description: <p align="center">
            <img width="500", src="https://raw.githubusercontent.com/katiebreivik/LEGWORK/main/docs/images/legwork.png">
        </p>
        
        <h2 align="center">
            The <b>L</b>ISA <b>E</b>volution and <b>G</b>ravitational <b>W</b>ave <b>OR</b>bit <b>K</b>it
            <br>
            <a href="https://codecov.io/gh/katiebreivik/LEGWORK">
              <img src="https://codecov.io/gh/katiebreivik/LEGWORK/branch/main/graph/badge.svg?token=FUG4RFYCWX)">
            </a>
            <a href='https://legwork.readthedocs.io/en/latest/?badge=latest'>
            <img src='https://readthedocs.org/projects/legwork/badge/?version=latest' alt='Documentation Status' />
            </a>
        </h2>
        
        <p align="center">
            A python package that does the <code>LEGWORK</code> for you by evolving binaries,
            computing signal-to-noise ratios for binary systems potentially observable with LISA
            and visualising the results.
        </p>
        
        # Installation
        ## Stable Version
        LEGWORK is available for installation on PyPI.
        You can install the latest stable version using ``pip`` as
        
            pip install legwork
        
        
        ## Development Version
        The latest development version is available directly from our
        [GitHub Repo](https://github.com/katiebreivik/LEGWORK)
        
            git clone https://github.com/katiebreivik/LEGWORK
            cd LEGWORK
            pip install .
        
        # Documentation
        You can find our documention [here](https://legwork.readthedocs.io/en/latest/)
        and explore various tutorials as well details on every module and function.
        
        # Development
        The source code is available [here](https://github.com/katiebreivik/LEGWORK)
        on GitHub and if you have an idea for a new feature, notice a bug or something else entirely,
        please [open an issue](https://github.com/katiebreivik/LEGWORK/issues/new) and let us know — we'd love to hear about it!
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
