Detailed API
============

Here, we provide detailed documentation for *many* of the functions that you may find useful when using SysSimPyPlots. They are organized into the following modules:

- :ref:`general.py <api_general>`

   Includes a collection of fundamental constants and functions, as well as some statistical and other miscellaneous functions.

- :ref:`load_sims.py <api_load_sims>`

   Contains the big functions for loading, processing, and manipulating the simulated catalogs.

- :ref:`compare_kepler.py <api_compare_kepler>`

   Contains the functions for loading and processing the Kepler catalogs, as well as functions for comparing catalogs (computing distances).

- :ref:`plot_catalogs.py <api_plot_catalogs>`

   Includes many functions for plotting figures for visualizing the catalogs and their properties.

- :ref:`plot_params.py <api_plot_params>`

   Includes some functions for plotting model parameter spaces. Also includes functions for loading files containing many evaluations of model parameters.

- :ref:`compute_RVs.py <api_compute_RVs>`

   Contains functions for computing, simulating, and fitting radial velocity observations of the simulated planetary systems.


.. toctree::
   :hidden:

   api_general
   api_load_sims
   api_compare_kepler
   api_plot_catalogs
   api_plot_params
   api_compute_RVs