Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
COSMIC v4.1.0
Logo
COSMIC v4.1.0
  • About
  • Installation
  • Configuration and output
    • Configuration files
    • Understanding COSMIC outputs
    • Impact of settings on evolution
      • pisn
      • LBV_flag
  • Tutorials
    • Evolving binaries
      • Evolving a single binary
      • Evolving multiple binaries
      • Evolving a fixed grid of binaries
      • Evolving a Monte-Carlo sampled population
    • Sampling initial populations
      • Independent distributions
      • Multidimensional distributions
      • ClusterMonteCarlo Sampling
    • Converged populations
      • Generate a population the COSMIC way
    • Re-running simulations
      • Re-running binaries
      • Restarting a binary
    • Timesteps and resolution
      • Dynamic time resolution
      • Modifying internal timesteps
    • Output analysis
      • Analysing your simulations
    • Miscellaneous
      • Multiprocessing in COSMIC
  • Full API Reference
    • Evolution (evolve)
      • read_tracks_for_METISSE
      • populate_tracks
      • Evolve
    • Sampling (sample)
      • InitialBinaryTable
      • InitialCMCTable
      • get_independent_sampler
      • Sample
      • get_multidim_sampler
      • MultiDim
      • get_cmc_sampler
      • CMCSample
      • M_enclosed
      • phi_r
      • rho_r
      • virial_radius_analytic
      • find_rmax_vir
      • find_sigma_sqr
      • get_positions
      • get_velocities
      • get_velocities_plummer
      • get_velocities_old
      • scale_pos_and_vel
      • draw_r_vr_vt
      • calc_rho
      • integrate_king_profile
      • virial_radius_numerical
      • find_sigma_sqr
      • get_positions
      • get_velocities
      • scale_pos_and_vel
      • draw_r_vr_vt
    • Output analysis (output)
      • save_initC
      • load_initC
      • COSMICOutput
      • COSMICPopOutput
    • Plotting binaries (plotting)
      • evolve_binary
      • plot_k_type
      • plot_radius
      • plot_mass
      • plot_Teff
      • plot_Mdot
      • plot_P_orb
      • plot_ecc
      • plot_HR_diagram
      • plot_binary_evol
      • evolve_and_plot
    • Utility functions (utils)
      • filter_bin_state
      • conv_select
      • mass_min_max_select
      • idl_tabulate
      • rndm
      • param_transform
      • dat_transform
      • dat_un_transform
      • knuth_bw_selector
      • error_check
      • check_initial_conditions
      • convert_kstar_evol_type
      • parse_inifile
      • pop_write
      • a_from_p
      • p_from_a
      • get_Z_from_FeH
      • get_FeH_from_Z
      • get_binfrac_of_Z
      • get_porb_norm
      • get_met_dep_binfrac
      • get_METISSE_metallicity_files
      • read_metallicity_file
      • read_format_file
      • read_MIST_track
      • read_other_track
      • read_eep_directory
      • to_f2py_str_array
      • explain_setting
  • Citing COSMIC
  • What’s New in COSMIC
  • For Developers
    • Codebase overview
    • Creating new settings
    • Adding options to existing settings
    • Debugging COSMIC
    • cosmic-settings.json file explained
Back to top
View this page
Edit this page

For Developers¶

This page is intended for developers who wish to contribute to the COSMIC codebase. If you are a user looking to install COSMIC, please refer to the installation guide.

  • Codebase overview
  • Creating new settings
  • Adding options to existing settings
  • Debugging COSMIC
  • cosmic-settings.json file explained
Next
Codebase overview
Previous
What’s New in COSMIC
Copyright © 2019-2026, Katie Breivik, Tom Wagg
Made with Sphinx and @pradyunsg's Furo