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
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!