Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.17 KB

README.md

File metadata and controls

46 lines (27 loc) · 2.17 KB

Takahe Logo

Documentation Status

Takahe is a simple libary that takes binary star systems (such as the BPASS model sets), and allows you to evolve them through time, to see how they merge, when they merge, and what happens in the final moments before merger.

Installation

Installation is handled via pip. Currently the package is not released on pypi but can be installed with pip install -e . in the root directory.

Documentation

You can read Takahe's latest documentation here, or documentation for specific versions can be found on the releases page.

Contributing

Contributions are welcome! Please read the Contributing Guidelines before getting started.

Issues?

If you have an issue: open an issue in the issue tracker! There's no such thing as a silly question; we were all one level of experience at some point or another. So if you have any issues feel free to make a new issue!


Miscellanea

Acknowledgements

This work makes use of v2.2 of the Binary Population and Spectral Synthesis (BPASS) models as described in Eldridge, Stanway et al. (2017) and Stanway & Eldridge et al. (2018).

Citing

A paper will be forthcoming in the future. In the meantime please use the following BibTeX entry:

@misc{takahe,
	title = {Takahe: Binary Star Systems with BPASS},
	author = {Richards, Sean},
	howpublished = {\url{https://github.com/krytic/takahe}},
	year = {2020}
}

The name "Takahe"

The name Takahe conforms to the naming convention employed by Eldridge, Stanway, Stevance, et al. BPASS releases are named after native creatures from New Zealand (e.g. Tuatara, the current version, is named for the native reptile known as the "living fossil"), as is hoki (being named for a fish). The Takahe is a native endangered flightless bird to New Zealand, and is regarded as taonga (treasure) to Ngāi Tahu, an iwi (tribe) in the South Island.