sarracen.read_gradsph

sarracen.read_gradsph(filename: str, separate_types: str = 'sinks') → List[SarracenDataFrame] | SarracenDataFrame

Read data from a GradSPH dump file.

Global values stored in the dump file are stored within the data frame in the dictionary params.

Parameters:

  • filename (str) – Name of the file to be loaded.

  • separate_types ({None, 'sinks', 'all'}, default='sinks') – Whether to separate SPH particles and sink particles into separate SarracenDataFrames. None returns all particle types in one SarracenDataFrame. ‘sinks’ and ‘all’ separate sink particles into a second SarracenDataFrame.

Return type:

SarracenDataFrame or list of SarracenDataFrame

Examples

By default, SPH particles are grouped into one SarracenDataFrame and sink particles into a second SarracenDataFrame.

>>> sdf, sdf_sinks = sarracen.read_gradsph('col3139')