SSPC code-base

This section contains the (auto)documentation for all the functions and modules in the source code of SSPC.

Contents:

• calculate_birth_redshift_array module
  • calculate_origin_redshift_array()
• calculate_starformation_rate module
  • calculate_digitized_sfr_rates_binned_data_for_backward_convolution()
  • calculate_digitized_sfr_rates_for_forward_convolution()
  • calculate_digitized_sfr_rates_non_binned_data_for_backward_convolution()
  • calculate_origin_time_array()
  • calculate_starformation()
  • general_sfr_digitise_function()
• check_and_prepare_output_file module
  • check_and_prepare_output_file()
• check_and_update_convolution_config module
  • check_and_update_convolution_config()
  • check_convolution_config()
  • check_convolution_config_general()
  • check_convolution_config_other()
  • update_convolution_config()
• check_and_update_convolution_instruction module
  • check_and_update_convolution_instruction()
  • check_and_update_convolution_instructions()
  • check_convolution_instruction()
  • check_delay_time_data_bin_info_dict()
  • check_metallicity()
• check_and_update_sfr_dict module
  • check_and_update_sfr_dict()
  • check_and_update_sfr_dicts()
  • check_sfr_dict()
  • pad_sfr_dict()
  • update_sfr_dict()
• convolution_by_integration module
  • convolution_by_integration_post_convolution_hook_wrapper()
• convolution_by_sampling module
  • convolution_by_sampling_post_convolution_hook_wrapper()
  • sample_systems()
  • select_dict_entries_with_new_indices()
• convolve module
  • convolve()
• convolve_binned_data module
  • calculate_overlap_fractions()
• convolve_on_the_fly module
  • convolve_on_the_fly()
  • convolve_on_the_fly_post_convolution_hook_wrapper()
  • handle_call_on_the_fly_function()
• convolve_populations module
  • convolution_job_worker()
  • convolution_queue_filler()
  • convolve_populations()
  • create_bin_iterator()
  • handle_convolution_choice()
  • handle_convolution_steps()
  • handle_multiprocessing_convolution()
  • handle_sequential_convolution()
  • handle_sequential_or_multiprocessing_convolution()
  • handle_storing_convolution_results()
  • post_convolution()
  • pre_convolution()
  • store_convolution_result_entries()
• convolve_pre_calculated_data module
  • convolve_pre_calculated_data()
• cosmology_utils module
  • age_of_universe_to_redshift()
  • lookback_time_to_redshift()
  • redshift_to_age_of_universe()
  • redshift_to_lookback_time()
• default_convolution_config module
  • array_validation()
  • callable_or_none_validation()
  • callable_validation()
  • dict_or_list_of_dicts_validation()
  • existing_path_validation()
  • list_of_dicts_validation()
  • logger_validation()
  • unit_validation()
• default_convolution_instruction module
• general_functions module
  • JsonCustomEncoder
    • JsonCustomEncoder.default()
  • calculate_bin_edges()
  • calculate_bincenters()
  • check_required()
  • create_job_dict()
  • create_time_bin_info_dict()
  • custom_json_serializer()
  • extract_data()
  • extract_unit_dict()
  • generate_boilerplate_outputfile()
  • generate_data_dict()
  • generate_group_name()
  • get_normalized_yield_unit()
  • get_physical_dimensions()
  • get_tmp_dir()
  • get_username()
  • handle_custom_scaling_or_conversion()
  • has_unit()
  • has_unit_dimensionless_okay()
  • is_mass_unit()
  • is_time_unit()
  • maybe_strip_scaled_dimensionless()
  • pad_function()
  • print_hdf5_structure()
  • sample_around_bin_center()
  • temp_dir()
  • vb()
  • verbose_print()
• metallicity_distributions module
  • compas_log_skew_normal_distribution_metallicity_distribution()
  • mean_metallicity()
  • mean_mu()
  • metallicity_distribution_Neijsel19()
  • metallicity_distribution_dummy()
  • metallicity_distribution_lognormal()
  • metallicity_distribution_vanSon2022()
• post_convolution_hook_routines module
  • extract_arguments()
  • handle_post_convolution_function()
• prepare_redshift_interpolator module
  • create_interpolation_datasets()
  • load_interpolation_data()
  • prepare_redshift_interpolator()
• starformation_rate_distributions module
  • madau_dickinson_sfr()
  • mor19_sfr()
  • starformation_rate_distribution_vanSon2023()
• store_redshift_shell_info module
  • create_shell_volume_dict()
  • store_redshift_shell_info()