[COLLECTION]: Expose and document functions

[DominicDirkx]

Hi all,

This issue is a collection of functions that are not yet exposed (EXP) to Python, or need to be documented (DOC).
Feel free to comment any functions where you feel this is needed or edit this top-level comment directly.
If a function needs small code examples, add them to #238.

tudatpy.astro:

• element_conversion
  • cartesian_to_unified_state_model (EXP & DOC)
  • unified_state_model_to_cartesian (EXP & DOC)
  • modified_rodrigues_parameters_to_quaternions (EXP & DOC)
  • quaternions_to_modified_rodrigues_parameters (EXP & DOC)
  • exponential_map_to_quaternions (EXP & DOC)
  • quaternions_to_exponential_map (EXP & DOC)
  • keplerian_to_cartesian: remove duplicate definition to avoid overload notation in API
• time_conversion
  • default_time_scale_converter check return type
  • year_and_days_in_year_to_calendar_date (EXP) documented in API but not yet exposed (?)
• fundamentals (DOC)
  • compute_shadow_function (DOC)
• two_body_dynamics
  • LambertTargeterIzzo (DOC)

tudatpy.data:

• save2txt and save_time_history_to_file are defined as the same function. Select a preferred alias and deprecate the other

tudatpy.interface:

• spice
  • compute_rotation_matrix_between_frames (DOC)

tudatpy.numerical_simulation:

• module-level

  • Estimator.variational_solver should return a SingleArcVariationalSimulator?

• environment

  • transform_to_inertial_orientation (DOC)
  • GroundStation (DOC)
  • GroundStationState (DOC)
  • GcrsToItrsRotationModel (DOC)
  • EarthOrientationAnglesCalculator (EXP & DOC)
  • rotation_matrix_body_fixed_to_topocentric (DOC)
  • Body.radiation_pressure_source (EXP, DOC)
  • Body.radiation_pressure_target (EXP, DOC)
  • RadiationSourceModel (EXP, DOC)
  • RadiationPressureTargetModel (EXP, DOC)
  • Body.rigid_body_properties (DOC)
  • RigidBodyProperties (EXP, DOC)
  • TimeDependentSphericalHarmonicsGravityField (DOC)
  • TimeDependentSphericalHarmonicsGravityField.gravity_field_variation_models (DOC)
  • GravityFieldVariationModel (DOC)
  • AtmosphereModel (EXP, DOC)
  • AerodynamicsReferenceFrameAngles (DOC)

• environment_setup

  • create_ephemeris (DOC) create_body_ephemeris is already exposed to the same function and documented -> replace create_ephemeris with create_body_ephemeris in examples WIP: API docs updates #212
  • add_radiation_pressure_target_model (DOC) WIP: API docs updates #212
  • remove add_radiation_pressure_interface from API docs -> deprecated WIP: API docs updates #212
  • create_aerodynamic_coefficient_interface (DOC)
  • add_ground_station (DOC)
  • add_mass_properties_model: should these be deprecated? It seems they were superseeded by add_rigid_body_properties?
  • BodyDeformationTypes (check if all values are exposed & DOC) Tudat astro gravitation to be exposed and documented #63
  • gravity_field.ring_model (DOC)

• propagation_setup

  • simulator.propagation_results.single_arc_results (EXP, DOC)
  • MultiArcPropagatorSettings.processing_settings (DOC)
  • HybridArcPropagatorSettings.processing_settings (DOC)
  • SingleArcPropagatorSettings.processing_settings (DOC)
  • SingleArcPropagatorSettings.termination_settings (DOC)
  • SingleArcPropagatorSettings.print_settings (DOC)
  • propagator.custom_state (DOC)
  • AccelerationMap: Clarify return type (dict), make consistent throughout docs
  • acceleration.radiation_pressure check docstring, it seems outdated? Function argument enum is exposed but not documented. Shouldn't the function return RadiationPressureAccelerationSettings?
  • create_body_ephemeris: Clarify what body_name arg actually does

• estimation_setup

  • observation.one_way_open_loop_doppler (DOC) Expose functionality around DopplerProperTimeRateSettings base class #37
  • observation.two_way_open_loop_doppler (DOC) Expose functionality around DopplerProperTimeRateSettings base class #37
  • parameter.periodic_spin_variations (DOC) Document the order of the estimated parameters #234
  • parameter.polar_motion_amplitudes (DOC) Document the order of the estimated parameters #234

• estimation

  • ObservationCollection (DOC)
  • SingleObservationSet (DOC)
  • some entries in CovarianceAnalysisInput, CovarianceAnalysisOutput, EstimationOutput (DOC)

[DominicDirkx]

MissileDatcom functionality can go, not sure it ever worked correctly to begin with

[DominicDirkx]

Body.ephemeris_frame_to_base_frame has been un-exposed. The return type is not exposed, and at present does not need to be (it's only used as a convenience in internal frame transformations)