summarymodify

The summarymodify executable is designed to modify an existing PESummary metafile from the command line. This may include modifying the label of the stored analysis.

To see help for this executable please run:

$ summarymodify --help
usage: summarymodify [-h] [--labels LABELS [LABELS ...]]
                     [--descriptions DESCRIPTIONS [DESCRIPTIONS ...]]
                     [--config CONFIG [CONFIG ...]] [-s SAMPLES [SAMPLES ...]]
                     [-w DIR] [--save_to_json] [--delimiter DELIMITER]
                     [--kwargs KWARGS [KWARGS ...]] [--preferred PREFERRED]
                     [--overwrite]
                     [--replace_posterior REPLACE_POSTERIOR [REPLACE_POSTERIOR ...]]
                     [--remove_posterior REMOVE_POSTERIOR [REMOVE_POSTERIOR ...]]
                     [--remove_label REMOVE_LABEL [REMOVE_LABEL ...]]
                     [--store_skymap STORE_SKYMAP [STORE_SKYMAP ...]]
                     [--force_replace]

This executable is used to modify a PESummary metafile from the command line

optional arguments:
  -h, --help            show this help message and exit
  --labels LABELS [LABELS ...]
                        labels you wish to modify. Syntax: `--labels
                        existing:new` where ':' is the default delimiter
  --descriptions DESCRIPTIONS [DESCRIPTIONS ...]
                        descriptions you wish to modify. Syntax
                        `--descriptions label:desc` where label is the
                        analysis you wish to change and desc is the new
                        description
  --config CONFIG [CONFIG ...]
                        config data you wish to modify. Syntax `--config
                        label:path` where label is the analysis you wish to
                        change and path is the path to a new configuration
                        file.
  -s SAMPLES [SAMPLES ...], --samples SAMPLES [SAMPLES ...]
                        Path to PESummary meta file you wish to modify
  -w DIR, --webdir DIR  Directory to write the output file
  --save_to_json        save the modified data in json format
  --delimiter DELIMITER
                        Delimiter used to seperate the existing and new
                        quantity
  --kwargs KWARGS [KWARGS ...]
                        kwargs you wish to modify. Syntax: `--kwargs
                        label/kwarg:item` where '/' is a delimiter of your
                        choosing (it cannot be ':'), kwarg is the kwarg name
                        and item is the value of the kwarg
  --preferred PREFERRED
                        label to set as the preferred run
  --overwrite           Overwrite the supplied PESummary meta file with the
                        modified version
  --replace_posterior REPLACE_POSTERIOR [REPLACE_POSTERIOR ...]
                        Replace the posterior for a given label. Syntax:
                        --replace_posterior label;a:/path/to/posterior.dat
                        where ';' is a delimiter of your choosing (it cannot
                        be '/' or ':'), a is the posterior you wish to replace
                        and item is a path to a one column ascii file
                        containing the posterior samples
                        (/path/to/posterior.dat)
  --remove_posterior REMOVE_POSTERIOR [REMOVE_POSTERIOR ...]
                        Remove a posterior distribution for a given label.
                        Syntax: --remove_posterior label:a where a is the
                        posterior you wish to remove
  --remove_label REMOVE_LABEL [REMOVE_LABEL ...]
                        Remove an entire analysis from the input file
  --store_skymap STORE_SKYMAP [STORE_SKYMAP ...]
                        Store the contents of a fits file in the metafile.
                        Syntax: --store_skymap label:path/to/skymap.fits
  --force_replace       Override the ValueError raised if the data is already
                        stored in the result file