py21cmmc.analyse.get_samples#

py21cmmc.analyse.get_samples(chain, indx=0, burnin=False)[source]#

Extract sample storage object from a chain.

Parameters:
  • chain (CosmoHammerSampler or str) – Either a CosmoHammerSampler, which is the output of the run_mcmc() function, or a path to an output HDF5 file containing the chain.

  • indx (int, optional) – This is used only if chain is a string. It gives the index of the samples in the HDF file. Usually this is zero.

  • burnin (bool) – Whether to return the burnin samples, rather than the actual run samples.

Returns:

store (a HDFStore object.)