Skip to main content

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]: http://nbviewer.ipython.org/url/www.astronomy.ohio-state.edu/~antognini/kozai_tutorial.ipynb [2]: http://adsabs.harvard.edu/abs/2002ApJ…578..775B [3]: http://adsabs.harvard.edu/abs/2011PhRvL.107r1101K [4]: http://adsabs.harvard.edu/abs/2013MNRAS.431.2155N [5]: http://arxiv.org/abs/1504.05957

Project details


Download files

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

Source Distribution

kozai-0.3.0.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

kozai-0.3.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file kozai-0.3.0.tar.gz.

File metadata

  • Download URL: kozai-0.3.0.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for kozai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 75f38d378074444c9dc0f367755d9f16f682c70c7b60ddc05a3c9215b1b8c803
MD5 bc907f55192797af31a1afb9268ef3a8
BLAKE2b-256 87c7d42184c584300dad285cdfc5bd8653eaa3250684514e942c9c22269f01c1

See more details on using hashes here.

File details

Details for the file kozai-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: kozai-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for kozai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f37a04442cf5e65fcd285b88d2602d43f38c29820c94554ebc91a131eceb6930
MD5 366e0f380bb801b35ef00b24b22504aa
BLAKE2b-256 1e8305f825d898eeca55a07dbe8067b9ee25c73703b6089af79eecd14ea59ea2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page