Sample file output

The output should include sample file, ready for public releases (with metadata and ideally a single file including all needed for reproducibility).

Linked with #229

added Feature-request label

changed milestone to %0.4.0

To kick the discussion of. We already output a "result" HDF5 file. You can download a complete example here. To inspect it, you can load it with any HDF5 reader (in theory). For example [*]

>>>  import deepdish
>>> result = deepdish.io.load(filename=GW150914_H1L1_dynesty_result.h5)
>>> result.keys()
dict_keys(['fixed_parameter_keys', 'injection_parameters', 'log_likelihood_evaluations', 'meta_data', 'nested_samples', 'parameter_labels', 'parameter_labels_with_unit', 'posterior', 'priors', 'sampler_kwargs', 'samples', 'search_parameter_keys', 'label', 'log_bayes_factor', 'log_evidence', 'log_evidence_err', 'log_noise_evidence', 'outdir', 'sampler', 'sampling_time'])

Here you can see the list of keys of what we currently save. We should add to this result object the software version information and perhaps (if possible) some user data (note there is an arbitrary meta_data field where you can throw any extra data you like.

Three questions - (a) what else should be in any publicly released file and what should be removed from that list? (beside the version information which of course should be tehre).

(b) Should their be a special public-release file type or can we simple use the "result" object which is already output (my preference is that they should be identical).

(c) Are there any reasons not to use a HDF5 file format? It seems universal to me, but others may know better.

[*] Note deepdish is the python-based HDF5 file reader/writer used by bilby for writing the files. It also provides a command line tool ddls which can be used to inspect the h5 file from the command line, e.g.

$ ddls GW150914_H1L1_dynesty_result.h5

@gregory.ashton,

I would like the approximant that was used to generate the samples to be stored somewhere in the output file for use in the summary pages (I don't think it is currently stored, although this could have been fixed and I could be using a slightly out of date version of bilby).

mentioned in issue #251 (closed)

That is a good idea, I've made an issue #251 (closed) which will resolve that and some.

I've also added !275 (merged) to add the bilby version information.

changed milestone to %Future

marked this issue as related to #162 (closed)

changed milestone to %1.0.0

added 1 deleted label

Closing as there isn't any specific task associated with this. The results file has been cleaned up and could be a "public" release. Feel free to open if you have a specific change suggestion.

closed