sorcha.ephemeris.simulation_setup

Functions

create_assist_ephemeris(→ tuple)	Build the ASSIST ephemeris object
_create_assist_ephemeris(→ tuple)	Build the ASSIST ephemeris object
furnish_spiceypy(args, auxconfigs)	Builds the SPICE kernel, downloading the required files if needed
generate_simulations(ephem, gm_sun, gm_total, ...)	Creates the dictionary of ASSIST simulations for the ephemeris generation
precompute_pointing_information(pointings_df, args, ...)	This function is meant to be run once to prime the pointings dataframe

Module Contents

create_assist_ephemeris(args, auxconfigs) → tuple

Build the ASSIST ephemeris object Parameter --------- args: dictionary

Dictionary of command-line arguments.

auxconfigs: dataclass

Dataclass of auxiliary configuration file arguments.

Returns:

• Ephem (ASSIST ephemeris object) -- The ASSIST ephemeris object

• gm_sun (float) -- value for the GM_SUN value

• gm_total (float) -- value for gm_total

_create_assist_ephemeris(auxconfigs, cache_dir=None) → tuple

Build the ASSIST ephemeris object Parameter --------- auxconfigs: dataclass

Dataclass of auxiliary configuration file arguments.

cache_dir: string, default=None

The base directory to place all downloaded files.

Returns:

• Ephem (ASSIST ephemeris object) -- The ASSIST ephemeris object

• gm_sun (float) -- value for the GM_SUN value

• gm_total (float) -- value for gm_total

furnish_spiceypy(args, auxconfigs)

Builds the SPICE kernel, downloading the required files if needed :param args: dictionary of command-line arguments. :type args: dictionary or sorchaArguments object :param auxconfigs: Dataclass of auxiliary configuration file arguments. :type auxconfigs: dataclass

generate_simulations(ephem, gm_sun, gm_total, orbits_df, args)

Creates the dictionary of ASSIST simulations for the ephemeris generation

Parameters:

• ephem (Ephem) -- The ASSIST ephemeris object

• gm_sun (float) -- Standard gravitational parameter GM for the Sun

• gm_total (float) -- Standard gravitational parameter GM for the Solar System barycenter

• orbits_df (dataframe) -- Pandas dataframe with the input orbits

• args (dictionary or sorchaArguments object) -- dictionary of command-line arguments.

Returns:

sim_dict -- Dictionary of ASSIST simulations

Return type:

dict

precompute_pointing_information(pointings_df, args, sconfigs)

This function is meant to be run once to prime the pointings dataframe with additional information that Assist & Rebound needs for it's work.

Parameters:

• pointings_df (pandas dataframe) -- Contains the telescope pointing database.

• args (dictionary) -- Command line arguments needed for initialization.

• sconfigs (dataclass) -- Dataclass of configuration file arguments.

Returns:

pointings_df -- The original dataframe with several additional columns of precomputed values.

Return type:

pandas dataframe