Quick Start

Set-up

Install Hoki

To install the most recent stable release of hoki you can use:

sudo pip3 install --user hoki

If you are feeling adventurous and want the most recent (in development) version of hoki, you can clone our GitHub repository

Download the BPASS models

BPASS models can be downloaded from the BPASS:

Download

Hoki Compatible

Release Date

Reference

BPASSv2.2

Yes

July 2018

Stanway & Eldridge (2018)

BPASSv2.1

?

October 2017

Eldridge, Stanway, Xiao, et al. (2017)

BPASSv2.0

?

BPASSv1

?

hoki is dedicated to being an interface with the BPASS models, but given the substancial size of the entire set of models, they are not downloaded upon installation of hoki, and you should download the models you want to work on.

Loading in Data

Tip

More details on the outputs mentioned below can be found in the BPASS manual.

Stellar Model Outputs

The current version does not interface with the stellar model outputs. To be continued…

The stellar model outputs are:

  • The binary stellar models

  • New OB stars atmospheric models

Stellar Population Outputs

A stellar output file can be loaded in using the model_output() function in the load module.

1
2
3
from hoki import load

output = load.model_output('path')

The function will figure out based on the file name what data is being loaded in and will return the appropriate data format: pandas.DataFrames in most cases, apart from HR diagrams, which have their own HRDiagrams class – because they’re quite a complex data structure.

Here we summarise the shape of the outputs (51 time bins) for a given metalicity and IMF.

Output

File Name Root

Shape

Massive star type numbers

numbers

51 x 21

Supernova Rates

supernova

51 x 18

Energy and elemental yields

yields

51 x 9

Stellar mass remaining at the end

starmass

51 x 3

HR diagrams

hrs

51 x 100 x 100 x 3 x 3

Spectral Synthesis Outputs

The spectral synthesis output files can be also loaded in using the model_output() function in the load module. All outputs are returned as pandas.DataFrames with sensible column names.

Output

File Name Root

Shape

Spectra (SEDs)

spectra

52x10E5

Ionizing flux predictions

ionizing

51x5

Colours (broad-band)

colours

51x26

The full suite of stellar models is also available from the BPASS website (careful, the file is big ~50GB), and they are required to make colour magnitude diagram (CMD) such as in Figure 24 of BPASSv2.1. Creating these CMD and exploring these files is very tricky - in a future release hoki will offer features to make this straight forward.

Citing Hoki

A peer-reviewed journal article about hoki will appear in due time but for now you can use the following bibtex entry:

@Misc{hoki_citation,
  author =   {Heloise Stevance},
  title =    {Hoki},
  howpublished = {\url{https://github.com/HeloiseS/hoki}},
  doi = {10.5281/zenodo.3445659},
  year = {2019}
  }

Please if you use `hoki` for your science, do include us in your publications! As you can imagine developing a tool and maintaining it for the community is very time consuming, and unfortunatly citations remain the most important metric.


See also

For dedicated tutorials about specific aspecs of hoki and BPASS, check our Cook Book section in the side bar!