main module

class main.SimRunner(config: Optional[core.config.Config] = None)

Bases: object

This class serves as the main entry point to the sim.

__init__(config: Optional[core.config.Config] = None) → None

Runs the sim from specified config path or from a Config Object.

Input structure:

“python3 src/main.py {file path} [-v]” File path is a required argument, verbose is an optional argument.

Example

“python3 src/main.py configs/freefall.json” “python3 src/main.py configs/test_angles.json -v”

run() → pandas.core.frame.DataFrame

Runs the sim and returns the truth and observed states in a pandas dataframe. Both the truth and observed states between each control cycle get thrown out (this is something we’ll probably want to change)

Returns

Dataframe of the true and observed states at each instant of observation.

Return type

pd.DataFrame

main.run_sim()