yt.analysis_modules.halo_analysis.halo_catalog.HaloCatalog.load

HaloCatalog.load(save_halos=True, save_catalog=False, njobs=-1, dynamic=False)[source]

Load a previously created halo catalog.

This is a wrapper around the main _run function with default arguments tuned for reloading halo catalogs and associated data. By default, halo objects are saved and the halo catalog is not written, opposite to the behavior of the create function.

Parameters:

save_halos : bool

If True, a list of all Halo objects is retained under the “halo_list” attribute. If False, only the compiles quantities are saved under the “catalog” attribute. Default: True

save_catalog : bool

If True, save the final catalog to disk. Default: False

njobs : int

The number of jobs over which to divide halo analysis. Choose -1 to allocate one processor per halo. Default: -1

dynamic : int

If False, halo analysis is divided evenly between all available processors. If True, parallelism is performed via a task queue. Default: False

See also

create