Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Evolve hierarchical triples.

Project description

# Kozai

Kozai is a Python package to evolve hierarchical triples in the secular approximation. Hierarchical triples may be evolved either using the Delaunay formalism (Naoz et al. 2013b) or the vectorial formalism (Katz et al. 2011). The quadrupole, octupole, and hexadecapole terms of the Hamiltonian may be toggled to be included (or not) in the equations of motion. Post-Newtonian terms may also be toggled to include both relativistic precession (PN 1) and gravitational radiation (PN 2.5) using terms from Blaes et al. (2002).

The package provides a TripleDelaunay object which may be integrated using the Delaunay orbital elements and a TripleVectorial which may be integrated using the eccentricity and angular momentum vectors. This allows the integration to occur within the context of an external Python program.

The underlying integrator is from the SciPy ODE package. By default this package uses VODE as its integration algorithm, but the algorithm may be changed to any of the other integration algorithms supported by the SciPy ODE package.

## Installation

The Kozai package is available on PyPI and can be installed with pip:

` pip install kozai `

Or, if you do not have the permissions to run the above:

` pip install --user kozai `

## Tutorial

An IPython notebook tutorial is in the docs folder. The tutorial can be also be accessed online [here.][1]

Note that you will need to separately install matplotlib to run the tutorial if you don’t have it installed already. matplotlib will be installed if you install the requirements-dev.txt file described below.

## Development

If you want to do any development on the kozai package it can help to install the dependencies in the requirements-dev.txt file. If you are in the root directory of the kozai repository you can do this as follows:

`sh pip install -r requirements-dev.txt `

## References

  • [Antognini, 2015, ArXiv 1504.05957][5]
  • [Blaes, O., Lee, M.H., & Socrates, A., 2002, ApJ, 578, 775][2]
  • [Katz, B., Dong, S., & Malhotra, R., 2011, PhRvL, 107, 181101][3]
  • [Naoz, S., Farr, W.M., Lithwick, Y., Rasio, F.A., & Teyssandier, J., 2013b, MNRAS, 431, 2155][4]

[1]: [2]:…578..775B [3]: [4]: [5]:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kozai, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size kozai-0.3.0-py3-none-any.whl (22.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size kozai-0.3.0.tar.gz (18.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page