Merge pull request tudat-team#87 from tudat-team/feature/docs-update

Update interfaces for v0.9.0
larshinueber · Feb 2, 2025 · 589a097 · 589a097
2 parents f7b2e7c + 442e253
commit 589a097
Show file tree

Hide file tree

Showing 17 changed files with 86 additions and 64 deletions.
diff --git a/estimation/covariance_estimated_parameters.ipynb b/estimation/covariance_estimated_parameters.ipynb
@@ -263,11 +263,12 @@
    "outputs": [],
    "source": [
     "# Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)\n",
-    "delfi_tle = environment.Tle(\n",
+    "delfi_tle = environment_setup.ephemeris.sgp4(\n",
     "    \"1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999\",\n",
-    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\"\n",
+    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\",\n",
+    "    frame_origin = \"Earth\", frame_orientation = \"J2000\"\n",
     ")\n",
-    "delfi_ephemeris = environment.TleEphemeris( \"Earth\", \"J2000\", delfi_tle, False )\n",
+    "delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)\n",
     "initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )"
    ]
   },

diff --git a/estimation/covariance_estimated_parameters.py b/estimation/covariance_estimated_parameters.py
@@ -187,11 +187,12 @@
 
 
 # Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)
-delfi_tle = environment.Tle(
+delfi_tle = environment_setup.ephemeris.sgp4(
     "1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999",
-    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68"
+    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68",
+    frame_origin = "Earth", frame_orientation = "J2000"
 )
-delfi_ephemeris = environment.TleEphemeris( "Earth", "J2000", delfi_tle, False )
+delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)
 initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )
 
 

diff --git a/estimation/covariance_propagation_example.ipynb b/estimation/covariance_propagation_example.ipynb
@@ -267,11 +267,12 @@
    "outputs": [],
    "source": [
     "# Retrieve the initial state of `Starlink-32101` using Two-Line-Elements (TLEs)\n",
-    "Starlink_tle = environment.Tle(\n",
+    "Starlink_tle = environment_setup.ephemeris.sgp4(\n",
     "    \"1 60447U 24144Y   24239.91667824 -.00652022  00000-0 -25508-2 0  9990\",\n",
-    "\"2 60447  53.1498 303.6008 0000548  88.4809  23.6264 15.87779028  3478\"\n",
+    "    \"2 60447  53.1498 303.6008 0000548  88.4809  23.6264 15.87779028  3478\",\n",
+    "    frame_origin = \"Earth\", frame_orientation = \"J2000\"\n",
     ")\n",
-    "Starlink_ephemeris = environment.TleEphemeris( \"Earth\", \"J2000\", Starlink_tle, False )\n",
+    "Starlink_ephemeris = environment_setup.create_body_ephemeris(Starlink_tle)\n",
     "initial_state = Starlink_ephemeris.cartesian_state( simulation_start_epoch )"
    ]
   },

diff --git a/estimation/covariance_propagation_example.py b/estimation/covariance_propagation_example.py
@@ -191,11 +191,12 @@
 
 
 # Retrieve the initial state of `Starlink-32101` using Two-Line-Elements (TLEs)
-Starlink_tle = environment.Tle(
+Starlink_tle = environment_setup.ephemeris.sgp4(
     "1 60447U 24144Y   24239.91667824 -.00652022  00000-0 -25508-2 0  9990",
-"2 60447  53.1498 303.6008 0000548  88.4809  23.6264 15.87779028  3478"
+    "2 60447  53.1498 303.6008 0000548  88.4809  23.6264 15.87779028  3478",
+    frame_origin = "Earth", frame_orientation = "J2000"
 )
-Starlink_ephemeris = environment.TleEphemeris( "Earth", "J2000", Starlink_tle, False )
+Starlink_ephemeris = environment_setup.create_body_ephemeris(Starlink_tle)
 initial_state = Starlink_ephemeris.cartesian_state( simulation_start_epoch )
 
 

diff --git a/estimation/full_estimation_example.ipynb b/estimation/full_estimation_example.ipynb
@@ -279,11 +279,12 @@
    "outputs": [],
    "source": [
     "# Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)\n",
-    "delfi_tle = environment.Tle(\n",
+    "delfi_tle = environment_setup.ephemeris.sgp4(\n",
     "    \"1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999\",\n",
-    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\"\n",
+    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\",\n",
+    "    frame_origin = \"Earth\", frame_orientation = \"J2000\"\n",
     ")\n",
-    "delfi_ephemeris = environment.TleEphemeris( \"Earth\", \"J2000\", delfi_tle, False )\n",
+    "delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)\n",
     "initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )"
    ]
   },

diff --git a/estimation/full_estimation_example.py b/estimation/full_estimation_example.py
@@ -191,11 +191,12 @@
 
 
 # Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)
-delfi_tle = environment.Tle(
+delfi_tle = environment_setup.ephemeris.sgp4(
     "1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999",
-    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68"
+    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68",
+    frame_origin = "Earth", frame_orientation = "J2000"
 )
-delfi_ephemeris = environment.TleEphemeris( "Earth", "J2000", delfi_tle, False )
+delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)
 initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )
 
 

diff --git a/estimation/mro_residuals_analysis.py b/estimation/mro_residuals_analysis.py
@@ -558,7 +558,7 @@ def perform_residuals_analysis(inputs):
         )
 
         # Create tabulated ephemeris for the MRO antenna
-        antenna_ephemeris = environment_setup.ephemeris.create_ephemeris(
+        antenna_ephemeris = environment_setup.ephemeris.create_body_ephemeris(
             antenna_ephemeris_settings, "Antenna"
         )
 

diff --git a/propagation/linear_sensitivity_analysis.ipynb b/propagation/linear_sensitivity_analysis.ipynb
@@ -285,11 +285,12 @@
    "outputs": [],
    "source": [
     "# Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)\n",
-    "delfi_tle = environment.Tle(\n",
+    "delfi_tle = environment_setup.ephemeris.sgp4(\n",
     "    \"1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999\",\n",
-    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\"\n",
+    "    \"2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68\",\n",
+    "    frame_origin = \"Earth\", frame_orientation = \"J2000\"\n",
     ")\n",
-    "delfi_ephemeris = environment.TleEphemeris( \"Earth\", \"J2000\", delfi_tle, False )\n",
+    "delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)\n",
     "initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )"
    ]
   },

diff --git a/propagation/linear_sensitivity_analysis.py b/propagation/linear_sensitivity_analysis.py
@@ -199,11 +199,12 @@
 
 
 # Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)
-delfi_tle = environment.Tle(
+delfi_tle = environment_setup.ephemeris.sgp4(
     "1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999",
-    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68"
+    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68",
+    frame_origin = "Earth", frame_orientation = "J2000"
 )
-delfi_ephemeris = environment.TleEphemeris( "Earth", "J2000", delfi_tle, False )
+delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)
 initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )
 
 

diff --git a/propagation/perturbed_satellite_orbit.ipynb b/propagation/perturbed_satellite_orbit.ipynb
diff --git a/propagation/perturbed_satellite_orbit.py b/propagation/perturbed_satellite_orbit.py
@@ -211,11 +211,12 @@
 
 
 # Retrieve the initial state of Delfi-C3 using Two-Line-Elements (TLEs)
-delfi_tle = environment.Tle(
+delfi_tle = environment_setup.ephemeris.sgp4(
     "1 32789U 07021G   08119.60740078 -.00000054  00000-0  00000+0 0  9999",
-    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68"
+    "2 32789 098.0082 179.6267 0015321 307.2977 051.0656 14.81417433    68",
+    frame_origin = "Earth", frame_orientation = "J2000"
 )
-delfi_ephemeris = environment.TleEphemeris( "Earth", "J2000", delfi_tle, False )
+delfi_ephemeris = environment_setup.create_body_ephemeris(delfi_tle)
 initial_state = delfi_ephemeris.cartesian_state( simulation_start_epoch )
 
 
@@ -252,7 +253,7 @@
         propagation_setup.acceleration.aerodynamic_type, "Delfi-C3", "Earth"
     ),
     propagation_setup.dependent_variable.single_acceleration_norm(
-        propagation_setup.acceleration.cannonball_radiation_pressure_type, "Delfi-C3", "Sun"
+        propagation_setup.acceleration.radiation_pressure_type, "Delfi-C3", "Sun"
     )
 ]
 
@@ -274,7 +275,9 @@
 
 # Create numerical integrator settings
 fixed_step_size = 10.0
-integrator_settings = propagation_setup.integrator.runge_kutta_4(fixed_step_size)
+integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(
+    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4
+)
 
 # Create propagation settings
 propagator_settings = propagation_setup.propagator.translational(

diff --git a/propagation/reentry_trajectory.ipynb b/propagation/reentry_trajectory.ipynb
@@ -608,7 +608,9 @@
     "\n",
     "# Create numerical integrator settings\n",
     "fixed_step_size = 0.5\n",
-    "integrator_settings = propagation_setup.integrator.runge_kutta_4(fixed_step_size)\n",
+    "integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(\n",
+    "    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4\n",
+    ")\n",
     "\n",
     "# Create the propagation settings\n",
     "propagator_settings = propagation_setup.propagator.translational(\n",

diff --git a/propagation/reentry_trajectory.py b/propagation/reentry_trajectory.py
@@ -401,7 +401,9 @@ def updateGuidance(self, current_time: float):
 
 # Create numerical integrator settings
 fixed_step_size = 0.5
-integrator_settings = propagation_setup.integrator.runge_kutta_4(fixed_step_size)
+integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(
+    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4
+)
 
 # Create the propagation settings
 propagator_settings = propagation_setup.propagator.translational(

diff --git a/propagation/solar_system_propagation.ipynb b/propagation/solar_system_propagation.ipynb
@@ -266,7 +266,9 @@
     "\n",
     "# Create numerical integrator settings\n",
     "fixed_step_size = 3600.0\n",
-    "integrator_settings = propagation_setup.integrator.runge_kutta_4(fixed_step_size)\n",
+    "integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(\n",
+    "    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4\n",
+    ")\n",
     "\n",
     "# Create propagation settings\n",
     "for propagation_variant in [\"barycentric\", \"hierarchical\"]:\n",

diff --git a/propagation/solar_system_propagation.py b/propagation/solar_system_propagation.py
@@ -190,7 +190,9 @@
 
 # Create numerical integrator settings
 fixed_step_size = 3600.0
-integrator_settings = propagation_setup.integrator.runge_kutta_4(fixed_step_size)
+integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(
+    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4
+)
 
 # Create propagation settings
 for propagation_variant in ["barycentric", "hierarchical"]:

diff --git a/propagation/thrust_satellite_engine.ipynb b/propagation/thrust_satellite_engine.ipynb
@@ -431,8 +431,8 @@
    "source": [
     "# Create numerical integrator settings.\n",
     "fixed_step_size = 10.0\n",
-    "integrator_settings = propagation_setup.integrator.runge_kutta_4(\n",
-    "    fixed_step_size\n",
+    "integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(\n",
+    "    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4\n",
     ")"
    ]
   },

diff --git a/propagation/thrust_satellite_engine.py b/propagation/thrust_satellite_engine.py
@@ -343,8 +343,8 @@ def compute_thrust_magnitude(self, current_time: float):
 
 # Create numerical integrator settings.
 fixed_step_size = 10.0
-integrator_settings = propagation_setup.integrator.runge_kutta_4(
-    fixed_step_size
+integrator_settings = propagation_setup.integrator.runge_kutta_fixed_step(
+    fixed_step_size, coefficient_set=propagation_setup.integrator.CoefficientSets.rk_4
 )