Retire some codes from the `/bin/` directory

[GarethCabournDavies]

Many executables in bin are seemingly unused, so here is a proposal

The chopping block

NOTE: The following table is based on what is used in the live search at the moment, offline search/pygrb configs and inference documentation/examples that I could find. Otherwise if something hasn't been updated since 2020, or I see a potential duplicate, it is in the table. If you see a code which definitely shouldn't be on the chopping block - comment below and I will remove it from the table, and possibly move stuff to the 'rearrange' list above. Please let me know by the end of March 2026

Executable	Last commit (excluding generic ones to all executables / moves)	Introduced	Comment	Who?
bin/pycbc_data_store	2019	2019		ahnitz
bin/pycbc_get_ffinal	2013	2013		ahnitz, cdcapano
bin/pycbc_inj_cut	2015	2015		Steve F
bin/pycbc_make_faithsim	2022	2013	superseded by bin/workflows/pycbc_make_faithsim_workflow?	MPillas
bin/pycbc_process_sngls	2020	2019		tdent
bin/pycbc_randomize_inj_dist_by_optsnr	2015	2015		???
bin/pycbc_source_probability_offline	2021	2021		veronica-villa tdent
bin/pycbc_splitbank	2023	2013	is this superseded by pycbc_hdf5_splitbank?
bin/pycbc_upload_xml_to_gracedb	2021	2015	superseded by pycbc_upload_single_event_to_gracedb?	GarethCabournDavies, spxiwh
bin/all_sky_search/pycbc_apply_rerank	2019	2019		ahnitz
bin/all_sky_search/pycbc_combine_coincident_events	2018	2018		spxiwh
bin/all_sky_search/pycbc_combine_statmap	2022	2015	superseded by pycbc_add_statmap	ahnitz
bin/all_sky_search/pycbc_distribute_background_bins	2016	2015
bin/all_sky_search/pycbc_fit_sngls_binned	2020	2016	I think this has more output options than fit_sngls_split_binned	tdent
bin/all_sky_search/pycbc_fit_sngls_over_param	2021	2016	Does fit_sngls_over_multiparam have the same features and efficiency with 1 parameter?	tdent
bin/all_sky_search/pycbc_followup_file	2019	2019		ahnitz
bin/all_sky_search/pycbc_get_loudest_params	2015	2015		Thomas Massinger
bin/all_sky_search/pycbc_rerank_passthrough	2019	2019		ahnitz
bin/all_sky_search/pycbc_template_recovery_hist	2019	2019	Should be plot anyway?	tdent
bin/inference/pycbc_inference_plot_acf	2019	2016		cmbiwer, cdcapano
bin/inference/pycbc_inference_plot_geweke	2018	2017		suomide1102
bin/inference/pycbc_inference_plot_thermodynamic_integrand	2019	2019		cdcapano
bin/minifollowups/pycbc_plot_chigram	2015	2015		ahnitz
bin/plotting/pycbc_mass_area_plot	2019	2019		Veronica-villa, tdent
bin/plotting/pycbc_mchirp_plots	2019	2019		Veronica-villa, tdent
bin/plotting/pycbc_page_banktriggerrate	2015	2014		spxiwh, ahnitz
bin/plotting/pycbc_page_recovery	2019	2015		tdent
bin/plotting/pycbc_plot_background_coincs	2015	2015		ahnitz
bin/plotting/pycbc_plot_Nth_loudest_coinc_omicron.py	2015	2015		Thomas Massinger
bin/plotting/pycbc_plot_psd_timefreq	2017	2015		Miriam Cabero
bin/plotting/pycbc_plot_range_vs_mtot	2015	2015		vaibhavtewari
bin/plotting/pycbc_plot_trigrate	2018	2018		tdent
bin/workflows/pycbc_make_psd_estimation_workflow	2019	2015		spxiwh

I'm not sure what the plan should be with the unused codes. Maybe add a warning at the start of each file that it may be removed, and to contact us if it is still in use? Then remove on a certain date?

[GarethCabournDavies]

I have tried to summarise development history for each code which are candidates for cleanup, and looking at the git history for who would be the best person to ask.

Tagging @ahnitz, @spxiwh @tdent @cdcapano @veronica-villa @MPillas @vaibhavtewari

[titodalcanton]

Please hold on until I have a bit more time for a careful look, there seems to be some stuff there that I do not want to remove (pycbc_create_injections???).

[GarethCabournDavies]

Please hold on until I have a bit more time for a careful look, there seems to be some stuff there that I do not want to remove (pycbc_create_injections???).

I had already removed that one from the list, but forgot to click to save the edits! - but yes I will be leaving this open a while

[spxiwh]

The following codes are 100% still in use and should not be on the chopping block. Still need to more carefully check others with my name on them:

bin/pycbc_inspiral_skymax
bin/pycbc_make_banksim (until verificator is better documented)
bin/all_sky_search/pycbc_cut_merge_triggers_to_tmpltbank
bin/bank/pycbc_aligned_bank_cat
bin/bank/pycbc_bank_verification
bin/bank/pycbc_geom_aligned_2dstack
bin/bank/pycbc_tmpltbank_to_chi_params
bin/workflows/pycbc_make_sbank_workflow
bin/workflows/pycbc_make_uberbank_workflow

[tdent]

Could you please publicize this issue in the slack pycbc code channel and set a date for requesting feedback? I see my name about 10 places but I don't think I will have any time in the next week, due to pre-existing deadlines, and I can't guarantee to get to this in the first week of February either.