sorcha.sorcha

Functions

`cite`()	Providing the bibtex, AAS Journals software latex command, and acknowledgement
`mem`(df)	Memory utility function that returns back how much memory the inputted pandas dataframe is using
`runLSSTSimulation`(args, sconfigs[, return_only])	Runs the post processing survey simulator functions that apply a series of

Module Contents

cite()[source]

Providing the bibtex, AAS Journals software latex command, and acknowledgement statements for Sorcha and the associated packages that power it.

Parameters:: None
Return type:: None

mem(df)[source]

Memory utility function that returns back how much memory the inputted pandas dataframe is using :param df: :type df: pandas dataframe

Returns:: usage
Return type:: int

runLSSTSimulation(args, sconfigs, return_only=False)[source]

Runs the post processing survey simulator functions that apply a series of filters to bias a model Solar System small body population to what the Vera C. Rubin Observatory Legacy Survey of Space and Time would observe.

Parameters:

args (dictionary or sorchaArguments object) -- dictionary of command-line arguments.
sconfigs (dataclass) -- Dataclass of configuration file arguments.
return_only (bool) -- Skip writing to disk and return observations and stats (if requested)

Return type:

None or observations DataFrame and stats DataFrame