Python API Docs

Simulation Development Workflow → Python API Docs

Up to date for Platform 0.36.1

Written by Connor Jakubik

Prerequisites:

• https://github.com/SimDynamX/SpaceTeamsPro/wiki/Python-Developer-Setup

---

spaceteams Python Library

We took most of the functionality that is available to sim developers in C++ and exposed it in a Python API as well. The sim developer can write a python script that is started as a Python System, where the script connects to a sim and interacts with it similarly to a C++ System.

Parameter type name	C++ typename	Python typename
double	double	float or (numpy object) np.float64
float	float	(numpy object) np.float32
int8, int16, int32, int64	int8_t, int16_t, int32_t, int64_t	(numpy object) np.int8, np.int16, np.int32, np.int64
uint8, uint16, uint32, uint64	uint8_t, uint16_t, uint32_t, uint64_t	(numpy object) np.uint8, np.uint16, np.uint32, np.uint64
doubleV2, doubleV3, doubleV4	SC_DoubleV2, SC_DoubleV3, SC_DoubleV4	(numpy object) np.array([])
doubleM2x2, doubleM3x3, doubleM4x4, doubleM5x5, doubleM6x6	SC_DoubleM2x2, SC_DoubleM3x3, SC_DoubleM4x4, SC_DoubleM5x5, SC_DoubleM6x6	(numpy object) np.matrix([])
timestamp	sc_tai_time	st.timestamp (has .as_datetime() function)
duration	sc_duration	datetime.timedelta

NOTE: The Python API docs currently do not include functions from the submodules such as file_io, SimGlobals, etc. We are working on a fix to our documentation generator. https://github.com/SimDynamX/SpaceTeamsPRO/issues/103

Link to Python API Documentation: https://simdynamx.github.io/SC_PythonAPI_documentation/spaceteams/SC_Compute_Server.html