star-privateer: stellar rotation and activity

Welcome to the documentation of star-privateer. The present module provides a complete API to implement tools for stellar surface rotation and activity analysis in photometric light curves collected by space missions such as NASA/Kepler, NASA/TESS or, in a near future, ESA/PLATO. Several tutorials are included in order to help new users that would like to discover the code.

The module is developed at the Osservatorio Astrofisico di Catania (INAF-OACT).

Contact address: sylvain.breton@inaf.it

Documentation

User guide

• Installation
• ROOSTER training framework
• Analysis framework for rotation period extraction
• Wavelet analysis for rotation period extraction

The "PLATO notebooks"

• Fourier analysis (MSAP4-01A)
• Time series analysis (MSAP4-02)
• Composite spectrum (CS), ROOSTER, and Sph index (MSAP4-03)
• Cycle determination (MSAP4-06)

Detailed API

• Analysis pipeline
  • analysis_pipeline()
  • Lomb-Scargle periodogram
  • Auto-correlation function (ACF)
  • Composite spectrum (CS)
  • Photometric index (Sph)
  • Wavelet analysis
  • Preprocessing
• ROOSTER
  • ROOSTER
  • create_rooster_feature_inputs()
  • load_rooster_instance()

About star-privateer

• Citing star-privateer