Commit 4b82a7d1 authored by Zoheyr Doctor's avatar Zoheyr Doctor 🔭
Browse files

Update README.md

parent 4c777c6d
# Twirl
### A tool for building cartoon animations of binaries.
## An example:
## Compatibility / Dependencies
This code is only supported in Python 3. It also depends on
Matplotlib and Numpy.
## Installation
Clone this repository and install from source:
```
git clone https://git.ligo.org/zoheyr-doctor/twirl.git
cd twirl
python setup.py install
```
## Tools
The main tool currently (this code is still under major development) is
the module `twirl.binary`. This module contains the `Binary` class that
defines individual binaries by their intrinsic parameters (masses, spins...)
and extrinsic parameters (viewing angle, as specified by Euler angles).
A preliminary script that uses this tool is `animate_binaries_from_file`, which
defines a binary for each event in a catalog and animates each binary in its
own subplot. It creates an animation like this one:
![](examples/orbit.gif)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment