Add PyGRB Exclusion Distance Table Executable #4756
Conversation
| if len(trials) == 0: | ||
| raise ValueError("No trials found in input files.") |
There was a problem hiding this comment.
Should we make --trial-name required in pycbc_pygrb_efficiency to prevent this? This way we have a check in place here for the standalone script, and a way to dodge the error in the workflow.
There was a problem hiding this comment.
Now that I looked better, pycbc_pygrb_efficiency must check that opts.trial_name is not None when exclusion_dist_output_file is not None.
bin/pygrb/pycbc_pygrb_efficiency
Outdated
| # Also include injection set name and trial name | ||
| if opts.exclusion_dist_output_file: | ||
| excl_dist_dict = {} | ||
| excl_dist_dict['inj_set'] = inj_set_name |
There was a problem hiding this comment.
The user must provide opts.injection_set_name if opts.exclusion_dist_output_file and/or opts.found_missed_file are provided.
Looking at this made me wonder about something I had not caught in the past: does it even make sense to have opts.found_missed_file and opts.onsource_file as optional? I.e., if do_injections and/or onsource_file are False, does the code do something meaningful (and not crash)? Otherwise we can promote those options to required and remove the ifs on do_injections andonsource_file.
There was a problem hiding this comment.
The injections part of the code uses results from the onsource analysis, so I'd say it wouldn't hurt anything to make both files required, but there could be cases I'm not considering.
Standard information about the request
This PR adds an executable to create a static table for PyGRB exclusion distances and updates
pycbc_pygrb_efficiencyto output the necessary data to a JSON file.This is a: new feature
This change affects: PyGRB
This change changes: result presentation
Motivation
PyGRB result webpages currently write the exclusion distances in the plot captions. A table containing this information would look nicer.
Contents
pycbc_pygrb_efficiencyto write a JSON file with the exclusion distancespycbc_pygrb_exclusion_distance_tablewhich takes the JSON output files and outputs a result table.Testing performed
An example of the resulting table can be seen here. This is a quick example generated on the command line. For a final result, the table will be added to the results webpage within the workflow generator (to be done in a later PR).
Additional notes