Sink snapshot class

Data stored in sink snapshot binaries can be easily obtained using the following class:

class arepy.files.sink(fileName='', simplex=False, varAccRad=False, accLum=False, sinkFeed=False, intPad=1, order='FormationOrder', reverse=False, verbose=False)

Sink snapshot object

Parameters

  • fileName (str) – Path to a sink snapshot file

  • simplex (bool) – Indicates whether SimpleX radiation is used.

  • varAccRad (bool) – Indicates whether Variable Accretion Radiation is used

  • accLum (bool) – Indicates whether Accretion Luminosity is used

  • sinkFeed (bool) – Indicates whether sink feeding is used

  • intPad (bool) – Number of bites to pad one snapshot block

  • order (str) – Name of the property that will be used to order a data

  • reverse (bool) – Reverse the order of data

  • verbose (bool) – Display more information

getValues(props, order=None, reverse=False, limit=None, dictionary=False)

Get values from a sink snapshot

Parameters

  • prop (list(str)) – Single property or property list to select

  • order (str) – Name of the property that will be used to order a data

  • reverse (bool) – Reverse the order of data

  • limit (int) – Restrict number of returned data

  • dictionary (bool) – Return single properties also in a dictionary

Returns

Data of a single property or an dictionary of multiple properties

Example of use:

>>> sink.getValues(['Mass','ID'])

{'Mass': [23.43, 234.34, 234.56,...],
 'ID': [234, 346, 236,...]}