Welcome to L98-59’s documentation!

Source Code Documentation

This document provides details on the modules within the src directory, detailing functionality, classes, methods, and attributes provided by each module.

Source Code Documentation:

• Config Loader
  • load_config()
• Pickle Data
  • clean_and_pickle()
  • unpickle_data()
• Periodogram
  • compute_periodogram()
  • convert_to_days()
  • convert_to_microhertz()
  • frequency_to_period()
  • plot_periodogram()
  • run_periodogram_plot()
• Prior Transforms
  • gaussian()
  • half_gaussian()
  • jeffreys()
  • kipping_beta()
  • modjeffreys()
  • rayleigh()
  • uniform()
• L98-59 Model
• Run L98-59

Unit Test Documentation

This document provides deatails on the unit tests for the project within the tests directory.

Unit Test Documentation:

• Pickle Tests
  • TestPickles
• L98-59 Tests

Indices and tables

• Index

• Module Index

• Search Page