User Guide

PBjam is intended to be a user-friendly peakbagging tool. The most straightforward way of using PBjam is through the session class. This class handles the organization of the inputs, the mode ID, peakbagging and output. The inputs to the session class can take a variety of forms which are shown in the examples below.

Session

The session class is the most straightforward way to analyze one or more stars with PBjam. It can automatically download the data and compute the power density spectrum, and then go through all the steps in the moden ID and peakbagging process. The Session notebook provides an example of how to use the session class.

Star

It’s also possible to use the star class to analyze single stars, mainly for use in custom scripts. The session class is really just a fancy wrapper for the star class.

The star class is meant for more detailed control of the inputs for each star. The Star notebook shows a simple example of this.

Advanced

It is not strictly necessary to use either the session or star classes. The mode ID and peakbag notebooks show a lower-level walkthrough of the steps that PBjam goes through for peakbagging.

Note

For additional useful examples see the Examples directory.

Papers

We have published a few papers on various bits. The first paper provides information mainly on the initial version of PBjam. The second paper discusses the method used to construct the prior probability densities that we now use in the latest version of PBjam. The latest paper (in prep.) focuses on how we construct the models for the l=1 modes.