Commit ee43ce0e authored by Zoheyr Doctor's avatar Zoheyr Doctor 🔭
Browse files

Update README.md

parent 92c80197
......@@ -20,11 +20,21 @@ 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). The
binary can then be evolved in its rotation with `Binary.orbit()` and projected
into the viewer's coordinates with `Binary.project()`.
into the viewer's coordinates with `Binary.project()`. The child class
`InspiralingBinary` will perform an inspiral on the binary based on
gravitational wave emission.
A preliminary script that uses this tool is `animate_binaries_from_file`, which
To facilitate animating the binaries, the module `twirl.artists` defines
classes for different objects you may want to animate. Currently, there are
the `BinaryBlackHole` and `BlackHoleRingdown` objects that will automatically
generate the Matplotlib artists for animation.
A preliminary script that uses these tools 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.mp4)
An inspiral and ringdown video is shown here:
![](examples/inspiral_ringdown.mp4)
\ No newline at end of file
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