velociraptor.catalogue.catalogue module¶

Main objects for the velociraptor reading library.

This is based upon the reading routines in the SWIFTsimIO library.

exception velociraptor.catalogue.catalogue.CatalogueTypeError[source]¶: Bases: Exception

class velociraptor.catalogue.catalogue.Catalogue(type: str)[source]¶

Bases: object

get_quantity(quantity_name: str)[source]¶

Get a quantity from the catalogue.

Parameters:	quantity_name (str) – Full path to the quantity.

register_derived_quantities(registration_file_path: Union[List[str], str]) → None[source]¶

Register any required derived quantities. These will be available through catalogue.derived_quantities.{your_names}.

For more information on this feature, see the documentation of velociraptor.catalogue.derived.DerivedQuantities.

Parameters:	registration_file_path (Union[List[str], str]) – Path to the python source file(s) that contain(s) the code to register the additional derived quantities.