Welcome to SysSimPyMMEN’s documentation!

SysSimPyMMEN is a framework for inferring the MMEN 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.

MMEN – short for “minimum-mass extrasolar nebula”. This is the idea of a power-law profile for the minimum mass in disk solids required to form the existing exoplanets, if they formed in their present locations (in situ formation).

Publication

Our paper for this project has been accepted to the Astronomical Journal! You can view an initial preprint on the arXiv.

Contents

• Installation
  • Using pip
  • From source
  • Installing SysSimPyPlots
  • Dependencies
• Basic usage
  • Computing solid surface densities
  • Fitting a power-law
  • An example using a SysSim catalog
• Fitting individual systems
  • Scaling up solid surface densities
  • Visualizing individual systems
  • Plotting a diversity of MMEN
• Detailed API
  • generate_planet_mass_from_radius_Ning2018_table()
  • σ_logM_linear_given_radius()
  • generate_planet_mass_from_radius_lognormal_mass_around_earthlike_rocky()
  • generate_planet_mass_from_radius_Ning2018_table_above_lognormal_mass_earthlike_rocky_below()
  • generate_planet_mass_from_radius_Ning2018_table_above_lognormal_mass_earthlike_rocky_below_vec()
  • feeding_zone_S2014()
  • feeding_zone_nHill()
  • feeding_zone_RC2014()
  • solid_surface_density()
  • solid_surface_density_CL2013()
  • solid_surface_density_S2014()
  • solid_surface_density_nHill()
  • solid_surface_density_system_RC2014()
  • solid_surface_density_prescription()
  • solid_surface_density_CL2013_given_physical_catalog()
  • solid_surface_density_S2014_given_physical_catalog()
  • solid_surface_density_nHill_given_physical_catalog()
  • solid_surface_density_RC2014_given_physical_catalog()
  • solid_surface_density_CL2013_given_observed_catalog()
  • solid_surface_density_S2014_given_observed_catalog()
  • solid_surface_density_nHill_given_observed_catalog()
  • solid_surface_density_RC2014_given_observed_catalog()
  • MMSN()
  • MMEN_power_law()
  • fit_power_law_MMEN()
  • fit_power_law_and_scale_up_MMEN()
  • fit_power_law_MMEN_all_planets_observed()
  • fit_power_law_MMEN_all_planets_physical()
  • fit_power_law_MMEN_per_system_observed()
  • fit_power_law_MMEN_per_system_physical()
  • fit_power_law_MMEN_per_system_observed_and_physical()
  • plot_feeding_zones_and_power_law_fit_MMEN_per_system_observed_and_physical()
  • solid_mass_integrated_r0_to_r_given_power_law_profile()