Skip to content

Add description field to metafile

Charlie Hoy requested to merge description into master

The purpose of this MR is to add an additional field to the pesummary metafile (description) which allows the user to add a short string to describe the analysis. This string is also printed into the metafile summary, e.g.

>>> from pesummary.io import read
>>> f = read("posterior_samples.h5")
>>> f
file: posterior_samples.h5
cls: pesummary.gw.file.formats.pesummary.PESummary
analyses: PublicationSamples

PublicationSamples
------------------
description: Samples used for plots
nsamples: 14448
parameters: log_likelihood, chi_eff, ..., psi_J, viewing_angle

This description is added via the --descriptions flag. This takes either a JSON file with descriptions for each analysis or a dictionary directly from the command line, e.g. --description PublicationSamples:"Samples used for plots"

Edited by Charlie Hoy

Merge request reports