Documentation

This is the documentation for salter.

Installation

Install via pip (via GitHub):

pip install https://github.com/bmorris3/salter/archive/master.zip

Dependencies

  • numpy
  • scipy
  • matplotlib
  • astropy
  • astroquery
  • batman-package
  • kplr
  • h5py

Prep your local data caches

  1. First open and run the notebook choose_targets.ipynb.

  2. In the repo, run this to construct and cache the database of kepler light curves (runtime = ~1 hr on conference wifi):

    python -c "from salter import cache_light_curves; cache_light_curves()"
    
  3. Run this to cache a local copy of the joined tables from the NASA Exoplanet Archive and the Exoplanet Orbit Database:

    python -c "from salter import cache_planets_table; cache_planets_table()"
    

salter Package

Functions

cache_light_curves() Run this after running choose_targets.ipynb in order to cache light curves into a local HDF5 archive.
cache_planets_table() Cache a joined table containing data from the NASA Exoplanet Archive and the Exoplanet Orbit Database.
concatenate_light_curves(light_curve_list[, …]) Combine multiple transit light curves into one TransitLightCurve object.
concatenate_transit_light_curves(…[, name]) Combine multiple transit light curves into one TransitLightCurve object.
get_planets_table() Get the joined planets table from the NASA Exoplanet Archive and the Exoplanet Orbit Database.
kic_to_params(kic) For a KIC number kic, return a TransitParams object for that star-planet system.
q2u(q1, q2) Convert the two parameter quadratic terms of the Kipping 2013 limb- darkening parameterization q_1 and q_2 to the standard linear and quadratic terms of the quadratic limb-darkening parameterization of Claret et al.
quad(Teff, logg, filt) Quadratic limb-darkening law.
subtract_add_divide(whole_lc, transits) Normalize transit light curves in transits with the “subtract-add-divide” method.
test([package, test_path, args, plugins, …]) Run the tests using py.test.
transit_model(kic, times) Compute a transit model for KIC kic at times times
u2q(u1, u2[, warnings]) Convert the linear and quadratic terms of the quadratic limb-darkening parameterization – called u_1 and u_2 in Kipping 2013 or a and b in Claret et al.

Classes

LightCurve([times, fluxes, errors, …]) Container object for light curves.
Residuals([residuals, buffer_duration, …]) Transit light curve residuals.
TransitLightCurve([times, fluxes, errors, …]) Container for a single transit light curve.

Class Inheritance Diagram

Inheritance diagram of salter.lightcurve.LightCurve, salter.stats.Residuals, salter.lightcurve.TransitLightCurve