legwork 0.1.2

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

The LISA Evolution and Gravitational Wave ORbit Kit

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

Stable Version

We recommend that you create a Conda environment for working with LEGWORK. You can do this by running

conda create --name legwork numpy scipy astropy numba matplotlib seaborn jupyter ipython

And then activate the environment by running

conda activate legwork

Once within the environment, LEGWORK is available for installation on PyPI which lets you install the latest stable version using pip. One last dependency is the schwimmbad package which is only available on PyPI not conda and therefore also needs to be brought in with pip. So now to complete the installation just run

pip install schwimmbad legwork

and you should be all set! Check out our quickstart tutorial to learn some LEGWORK basics.

If you see an error about llvmlite of the form "ERROR: Cannot uninstall 'llvmlite'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall." this is due to the nature of the llvmlite and numba packages and can be avoided by instead running

pip install schwimmbad legwork --ignore-installed llvmlite

Development Version

The latest development version is available directly from our GitHub Repo

git clone https://github.com/TeamLEGWORK/LEGWORK
cd LEGWORK
pip install .

Documentation

You can find our documentation here and explore various tutorials as well details on every module and function.

Development

The source code is available here on GitHub and if you have an idea for a new feature, notice a bug or something else entirely, please open an issue and let us know — we'd love to hear about it!