Welcome to SysSimPyPlots’s documentation!

SysSimPyPlots is a codebase for loading, analyzing, and plotting catalogs generated from the SysSim models.

Tip

What’s behind the name?

SysSim – a comprehensive forward modeling framework for studying planetary systems based on the Kepler mission. In particular, SysSimExClusters provides clustered planetary system models that characterize the underlying occurrence and intra-system correlations of multi-planet systems.

Py – this package is written almost entirely in Python 3. This is unlike the SysSim codebase which is written in Julia.

Plots – while the SysSim codebase provides the workhorse for simulating catalogs of planetary systems and the Kepler mission, this package allows you to plot, visualize, and explore those catalogs!

Note

Feel free to create an issue on Github if you find any problems.

Contents

• Installation
  • Using pip
  • From source
  • Downloading simulated catalogs
  • Dependencies
  • If you want to go further
• Loading catalogs
  • Loading physical catalogs
  • Loading observed catalogs
  • Reading simulation parameters
  • Loading the Kepler catalog
• Plotting histograms
  • A simple example
  • Over-plotting the Kepler catalog
  • Plotting multiple catalogs
  • Plotting CDFs
• Comparing catalogs
  • Computing KS distances
  • Computing AD distances
  • Labeling distances on CDF plots
  • Summing multiple distances
• Visualizing catalogs
  • Plotting a simple gallery
  • Sorting and labeling systems
  • Plotting detected/undetected planets
  • More customizations
  • Other ways of plotting catalogs
• Computing occurrence rates
  • A few simple examples
• Detailed API
  • general.py
  • load_sims.py
  • compare_kepler.py
  • plot_catalogs.py
  • plot_params.py
  • compute_RVs.py

Publications

The scripts in this package have been used to produce some of the figures and results in several papers:

• Architectures of Exoplanetary Systems. IV: A Multi-planet Model for Reproducing the Radius Valley and Intra-system Size Similarity of Planets around Kepler’s FGK Dwarfs

  Matthias Y. He, Eric B. Ford, submitted 2025, under review

• Inner Planetary System Gap Complexity is a Predictor of Outer Giant Planets

  Matthias Y. He, Lauren M. Weiss, 2023, AJ, 166, 36-48

• Debiasing the Minimum-Mass Extrasolar Nebula: On the Diversity of Solid Disk Profiles

  Matthias Y. He, Eric B. Ford, 2022, AJ, 164, 210-220

• Friends and Foes: Conditional Occurrence Rates of Exoplanet Companions and their Impact on Radial Velocity Follow-up Surveys

  Matthias Y. He, Eric B. Ford, Darin Ragozzine, 2021b, AJ, 162, 216-238

• Architectures of Exoplanetary Systems. III: Eccentricity and Mutual Inclination Distributions of AMD-stable Planetary Systems

  Matthias Y. He, Eric B. Ford, Darin Ragozzine, Daniel Carrera, 2020, AJ, 160, 276-314

• Architectures of Exoplanetary Systems. II: An Increase in Inner Planetary System Occurrence Towards Later Spectral Types for Kepler’s FGK Dwarfs

  Matthias Y. He, Eric B. Ford, Darin Ragozzine, 2021a, AJ, 161, 16-40

• Architectures of Exoplanetary Systems. I: A Clustered Forward Model for Exoplanetary Systems around Kepler’s FGK Stars

  Matthias Y. He, Eric B. Ford, Darin Ragozzine, 2019, MNRAS, 490, 4575-4605