Tudatpy has its functionality divided into a number of submodules. A brief description of each submodule, as well as a detailed listing of all functions/class in each submodule, can be found on our API documentation website. On this page, we give a brief top-level overview of which type of functionality is in which (group of) submodules, and why.
The top-level submodules of tuduatpy are:
tudatpy.numerical_simulation This submodule contains the interfaces for the primary application of Tudatpy: numerical state propagation and estimation. The functionality in this submodule consists of a large number of interconnected elements that work together as a whole. The usability of separate functions/classes in this submodule outside of the Tudatpy framework is very limited, and this functionality is typically only used within a Tudatpy numerical simulation. Its further subdivision into submodules is discussed in more detail below.
tudatpy.astro This submodule contains various (semi-)standalone functions for astrodynamics applications, which can be used very well outside of a Tudat application/propagation. Submodules contain lists of frame conversions, element conversion, elementary orbit calculations, etc..
tudatpy.trajectory_design This submodule contains functionality for the preliminary design of a full (transfer) orbit, using for instance a Muliple Gravity Assist (MGA) or a low-thrust system. It relies on functionality in the
astrosubmodule. It is largely independent of the
numerical_simulationsubmodule, but does contain interface functions to allow the preliminary design to be used as an initial guess for a full numerical propagation.
tudatpy.math This submodule contains various functions and classes for purely mathematical operations, such as numerical interpolation, etc..
tudatpy.plotting This submodule contains various pieces of functionality to support the easy plotting of results generated with Tudatpy. Unlike most of the main Tudatpy submodules (which are written in C++, and exposed to Python), this submodule is written in Python
tudatpy.util This submodule contains various small pieces of functionality to support the easy post-processing of results generated with Tudatpy. Unlike most of the main Tudatpy submodules (which are written in C++, and exposed to Python), this submodule is written in Python
tudatpy.io This submodule contains various pieces of functionality for file input-output in Tudatpy. Unlike most of the main Tudatpy submodules (which are written in C++, and exposed to Python), this submodule is written partially in Python
The numerical_simulation submodules
This submodule contains the bulk of the functionality in Tudat, and is subdivided into six submodules, two for functionality related to the environment, propagation and estimation:
tudatpy.numerical_simulation.propagation_setup/tudatpy.numerical_simulation.propagation Functionality related to numerical propagation of states (state types, acceleration models, ouput variables, etc.)
The distinction between the
foo_setup libraries is the following:
numerical_simulation.foo_setupsubmodule contains no actual functionality to perform any calculations. It contains a long list of settings that are used to create the models that do the actual calculations. The functionality in this library largely consists of factory functions to create
numerical_simulation.foosubmodule contains the functionality to perform the actual calculations. Typically, the objects in this submodule are created from one or more
Settingsobjects created in the
foo_setuplibrary. These objects may have various interdependencies which are difficult to manually implement, but straightforward to conceptually define with a string, boolean, etc. For instance: it is easy to state that a set of aerodynamic coefficients dependent on angle of attack (this is defined in the
environment_setupsubmodule), while it is rather cumbersome to manually extract the angle of attack, and input it to the aerodynamic coefficient during every time step. The objects that do this automatically come from the
environmentsubmodule. In addition, the
numerical_simulation.foolibraries also contain a number of functions that can be used to process propagation results, or extract information from one or more objects in the