yt_astro_analysis.halo_analysis.halo_catalog.halo_catalog.HaloCatalog.create¶

HaloCatalog.create(save_halos=False, save_output=True, njobs='auto', dynamic=False)¶

Create the halo catalog given the callbacks, quantities, and filters that have been provided.

This is a wrapper around the main _run function with default arguments tuned for halo catalog creation. By default, halo objects are not saved but the halo catalog is written, opposite to the behavior of the load 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: False
save_output (bool) – If True, save the final catalog to disk. Default: True
njobs (int) – The number of jobs over which to divide halo analysis. If set to “auto”, use a task queue if total number of processors is an odd number and divide jobs evenly if an even number. Default: “auto”
dynamic (int) – If False, halo analysis is divided evenly between all available processors. If True, parallelism is performed via a task queue. If njobs is set to “auto”, behavior is controlled in the way described above. Default: False