py21cmfast.cache_tools.query_cache

py21cmfast.cache_tools.query_cache(*, direc=None, kind=None, hsh=None, seed=None, redshift=None, show=True)[source]

Get or print datasets in the cache.

Walks through the cache, with given filters, and return all un-initialised dataset objects, optionally printing their representation to screen. Useful for querying which kinds of datasets are available within the cache, and choosing one to read and use.

Parameters:

  • direc (str, optional) – The directory in which to search for the boxes. By default, this is the centrally-managed directory, given by the config.yml in ~/.21cmfast.

  • kind (str, optional) – Filter by this kind. Must be one of “InitialConditions”, “PerturbedField”, “IonizedBox”, “TsBox” or “BrightnessTemp”.

  • hsh (str, optional) – Filter by this hsh.

  • seed (str, optional) – Filter by this seed.

  • show (bool, optional) – Whether to print out a repr of each object that exists.

Yields:

obj – Output objects, un-initialized.