Commit 92d3efff authored by Zoheyr Doctor's avatar Zoheyr Doctor 🔭
Browse files

Update README.md

parent 6ee395b8
# Twirl
### A tool for building cartoon animations of binaries.
### Warning: This tool is currently under major development
## Compatibility / Dependencies
This code is only supported in Python 3. It also depends on
......@@ -17,7 +18,9 @@ python setup.py install
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).
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()`.
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
......
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