Merge branch 'develop' into enh/function-crop-clip-methods

Author: Gui-FernandesBR

.github/workflows/test_pytest.yaml

@@ -29,14 +29,11 @@ jobs:
         uses: actions/setup-python@main
         with:
           python-version: ${{ matrix.python-version }}
-
-      - name: Cache Python dependencies
-        uses: actions/cache@main
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-tests.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            requirements-tests.txt
+            requirements-optional.txt
 
       - name: Install rocketpy
         run: pip install .

CHANGELOG.md

@@ -35,6 +35,9 @@ Attention: The newest changes should be on top -->
 
 ### Changed
 
+-  ENH: Add the Coriolis Force to the Flight class [#799](https://github.com/RocketPy-Team/RocketPy/pull/799)
+- ENH: _MotorPrints inheritance - issue #460 [#828](https://github.com/RocketPy-Team/RocketPy/pull/828)
+- MNT: fix deprecations and warnings [#829](https://github.com/RocketPy-Team/RocketPy/pull/829)
 
 ### Fixed
 
@@ -44,7 +47,7 @@ Attention: The newest changes should be on top -->
 ### Added
 - ENH: Support for ND arithmetic in Function class. [#810] (https://github.com/RocketPy-Team/RocketPy/pull/810)
 - ENH: allow users to provide custom samplers [#803](https://github.com/RocketPy-Team/RocketPy/pull/803)
-- ENH: Implement Multivariate Rejection Sampling (MRS) [#738] (https://github.com/RocketPy-Team/RocketPy/pull/738) 
+- ENH: Implement Multivariate Rejection Sampling (MRS) [#738] (https://github.com/RocketPy-Team/RocketPy/pull/738)
 - ENH: Create a rocketpy file to store flight simulations [#800](https://github.com/RocketPy-Team/RocketPy/pull/800)
 - ENH: Support for the RSE file format has been added to the library [#798](https://github.com/RocketPy-Team/RocketPy/pull/798)
 - ENH: Introduce Net Thrust with pressure corrections [#789](https://github.com/RocketPy-Team/RocketPy/pull/789)

requirements.txt

@@ -1,6 +1,6 @@
 numpy>=1.13
 scipy>=1.0
-matplotlib>=3.0
+matplotlib>=3.9.0  # Released May 15th 2024
 netCDF4>=1.6.4
 requests
 pytz

rocketpy/environment/environment.py

@@ -27,15 +27,14 @@
     find_latitude_index,
     find_longitude_index,
     find_time_index,
+    geodesic_to_utm,
     get_elevation_data_from_dataset,
     get_final_date_from_time_array,
     get_initial_date_from_time_array,
     get_interval_date_from_time_array,
     get_pressure_levels_from_file,
     mask_and_clean_dataset,
 )
-from rocketpy.environment.tools import geodesic_to_utm as geodesic_to_utm_tools
-from rocketpy.environment.tools import utm_to_geodesic as utm_to_geodesic_tools
 from rocketpy.environment.weather_model_mapping import WeatherModelMapping
 from rocketpy.mathutils.function import NUMERICAL_TYPES, Function, funcify_method
 from rocketpy.plots.environment_plots import _EnvironmentPlots
@@ -248,6 +247,8 @@ class Environment:
         Number of ensemble members. Only defined when using Ensembles.
     Environment.ensemble_member : int
         Current selected ensemble member. Only defined when using Ensembles.
+    Environment.earth_rotation_vector : list[float]
+        Earth's angular velocity vector in the Flight Coordinate System.
 
     Notes
     -----
@@ -353,6 +354,7 @@ def __init__(
         self.set_location(latitude, longitude)
         self.__initialize_earth_geometry(datum)
         self.__initialize_utm_coordinates()
+        self.__set_earth_rotation_vector()
 
         # Set the gravity model
         self.gravity = self.set_gravity_model(gravity)
@@ -451,7 +453,7 @@ def __initialize_utm_coordinates(self):
                 self.initial_utm_letter,
                 self.initial_hemisphere,
                 self.initial_ew,
-            ) = self.geodesic_to_utm(
+            ) = geodesic_to_utm(
                 lat=self.latitude,
                 lon=self.longitude,
                 flattening=self.ellipsoid.flattening,
@@ -584,6 +586,23 @@ def __reset_wind_direction_function(self):
         self.wind_direction.set_outputs("Wind Direction (Deg True)")
         self.wind_direction.set_title("Wind Direction Profile")
 
+    def __set_earth_rotation_vector(self):
+        """Calculates and stores the Earth's angular velocity vector in the Flight
+        Coordinate System, which is essential for evaluating inertial forces.
+        """
+        # Sidereal day
+        T = 86164.1  # seconds
+
+        # Earth's angular velocity magnitude
+        w_earth = 2 * np.pi / T
+
+        # Vector in the Flight Coordinate System
+        lat = np.radians(self.latitude)
+        w_local = [0, w_earth * np.cos(lat), w_earth * np.sin(lat)]
+
+        # Store the attribute
+        self.earth_rotation_vector = w_local
+
     # Validators (used to verify an attribute is being set correctly.)
 
     def __validate_dictionary(self, file, dictionary):
@@ -2523,98 +2542,7 @@ def set_earth_geometry(self, datum):
                 f"the following recognized datum: {available_datums}"
             ) from e
 
-    # Auxiliary functions - Geodesic Coordinates
-
-    @staticmethod
-    def geodesic_to_utm(
-        lat, lon, semi_major_axis=6378137.0, flattening=1 / 298.257223563
-    ):
-        """Function which converts geodetic coordinates, i.e. lat/lon, to UTM
-        projection coordinates. Can be used only for latitudes between -80.00°
-        and 84.00°
-
-        Parameters
-        ----------
-        lat : float
-            The latitude coordinates of the point of analysis, must be contained
-            between -80.00° and 84.00°
-        lon : float
-            The longitude coordinates of the point of analysis, must be
-            contained between -180.00° and 180.00°
-        semi_major_axis : float
-            The semi-major axis of the ellipsoid used to represent the Earth,
-            must be given in meters (default is 6,378,137.0 m, which corresponds
-            to the WGS84 ellipsoid)
-        flattening : float
-            The flattening of the ellipsoid used to represent the Earth, usually
-            between 1/250 and 1/150 (default is 1/298.257223563, which
-            corresponds to the WGS84 ellipsoid)
-
-        Returns
-        -------
-        x : float
-            East coordinate, always positive
-        y : float
-            North coordinate, always positive
-        utm_zone : int
-            The number of the UTM zone of the point of analysis, can vary
-            between 1 and 60
-        utm_letter : string
-            The letter of the UTM zone of the point of analysis, can vary
-            between C and X, omitting the letters "I" and "O"
-        hemis : string
-            Returns "S" for southern hemisphere and "N" for Northern hemisphere
-        EW : string
-            Returns "W" for western hemisphere and "E" for eastern hemisphere
-        """
-        warnings.warn(
-            "This function is deprecated and will be removed in v1.10.0. "
-            "Please use the new method `tools.geodesic_to_utm` instead.",
-            DeprecationWarning,
-        )
-        return geodesic_to_utm_tools(lat, lon, semi_major_axis, flattening)
-
-    @staticmethod
-    def utm_to_geodesic(
-        x, y, utm_zone, hemis, semi_major_axis=6378137.0, flattening=1 / 298.257223563
-    ):
-        """Function to convert UTM coordinates to geodesic coordinates
-        (i.e. latitude and longitude).
-
-        Parameters
-        ----------
-        x : float
-            East UTM coordinate in meters
-        y : float
-            North UTM coordinate in meters
-        utm_zone : int
-            The number of the UTM zone of the point of analysis, can vary
-            between 1 and 60
-        hemis : string
-            Equals to "S" for southern hemisphere and "N" for Northern
-            hemisphere
-        semi_major_axis : float
-            The semi-major axis of the ellipsoid used to represent the Earth,
-            must be given in meters (default is 6,378,137.0 m, which corresponds
-            to the WGS84 ellipsoid)
-        flattening : float
-            The flattening of the ellipsoid used to represent the Earth, usually
-            between 1/250 and 1/150 (default is 1/298.257223563, which
-            corresponds to the WGS84 ellipsoid)
-
-        Returns
-        -------
-        lat : float
-            latitude of the analyzed point
-        lon : float
-            latitude of the analyzed point
-        """
-        warnings.warn(
-            "This function is deprecated and will be removed in v1.10.0. "
-            "Please use the new method `tools.utm_to_geodesic` instead.",
-            DeprecationWarning,
-        )
-        return utm_to_geodesic_tools(x, y, utm_zone, hemis, semi_major_axis, flattening)
+    # Auxiliary functions
 
     @staticmethod
     def calculate_earth_radius(

rocketpy/mathutils/function.py

@@ -10,10 +10,10 @@
 from bisect import bisect_left
 from collections.abc import Iterable
 from copy import deepcopy
+from enum import Enum
 from functools import cached_property
 from inspect import signature
 from pathlib import Path
-from enum import Enum
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -24,7 +24,7 @@
     RBFInterpolator,
 )
 
-from rocketpy.tools import from_hex_decode, to_hex_encode
+from rocketpy.tools import deprecated, from_hex_decode, to_hex_encode
 
 from ..plots.plot_helpers import show_or_save_plot
 
@@ -1630,14 +1630,13 @@ def plot(self, *args, **kwargs):
             else:
                 print("Error: Only functions with 1D or 2D domains can be plotted.")
 
+    @deprecated(
+        reason="The `Function.plot1D` method is set to be deprecated and fully "
+        "removed in rocketpy v2.0.0",
+        alternative="Function.plot_1d",
+    )
     def plot1D(self, *args, **kwargs):  # pragma: no cover
         """Deprecated method, use Function.plot_1d instead."""
-        warnings.warn(
-            "The `Function.plot1D` method is set to be deprecated and fully "
-            + "removed in rocketpy v2.0.0, use `Function.plot_1d` instead. "
-            + "This method is calling `Function.plot_1d`.",
-            DeprecationWarning,
-        )
         return self.plot_1d(*args, **kwargs)
 
     def plot_1d(  # pylint: disable=too-many-statements
@@ -1736,14 +1735,13 @@ def plot_1d(  # pylint: disable=too-many-statements
         if return_object:
             return fig, ax
 
+    @deprecated(
+        reason="The `Function.plot2D` method is set to be deprecated and fully "
+        "removed in rocketpy v2.0.0",
+        alternative="Function.plot_2d",
+    )
     def plot2D(self, *args, **kwargs):  # pragma: no cover
         """Deprecated method, use Function.plot_2d instead."""
-        warnings.warn(
-            "The `Function.plot2D` method is set to be deprecated and fully "
-            + "removed in rocketpy v2.0.0, use `Function.plot_2d` instead. "
-            + "This method is calling `Function.plot_2d`.",
-            DeprecationWarning,
-        )
         return self.plot_2d(*args, **kwargs)
 
     def plot_2d(  # pylint: disable=too-many-statements

rocketpy/motors/motor.py

@@ -1151,7 +1151,7 @@ def vacuum_thrust(self):
         Returns
         -------
         vacuum_thrust : Function
-            The rocket's thrust in a vaccum.
+            The rocket's thrust in a vacuum.
         """
         if self.reference_pressure is None:
             warnings.warn(

rocketpy/plots/monte_carlo_plots.py

@@ -183,6 +183,7 @@ def all(self, keys=None):
             ax2 = fig.add_subplot(gs[1])
 
             # Plot boxplot
+            # TODO: changes vert to orientation="horizontal" when support for Py3.9 ends
             ax1.boxplot(self.monte_carlo.results[key], vert=False)
             ax1.set_title(f"Box Plot of {key}")
             ax1.set_yticks([])

rocketpy/prints/hybrid_motor_prints.py

@@ -1,7 +1,9 @@
 import numpy as np
 
+from .motor_prints import _MotorPrints
 
-class _HybridMotorPrints:
+
+class _HybridMotorPrints(_MotorPrints):
     """Class that holds prints methods for HybridMotor class.
 
     Attributes
@@ -26,6 +28,7 @@ def __init__(
         -------
         None
         """
+        super().__init__(hybrid_motor)
         self.hybrid_motor = hybrid_motor
 
     def nozzle_details(self):
@@ -63,28 +66,6 @@ def grain_details(self):
         print(f"Grain Volume: {self.hybrid_motor.solid.grain_initial_volume:.3f} m3")
         print(f"Grain Mass: {self.hybrid_motor.solid.grain_initial_mass:.3f} kg\n")
 
-    def motor_details(self):
-        """Prints out all data available about the HybridMotor.
-
-        Returns
-        -------
-        None
-        """
-        print("Motor Details")
-        print(f"Total Burning Time: {self.hybrid_motor.burn_duration} s")
-        print(
-            f"Total Propellant Mass: {self.hybrid_motor.propellant_initial_mass:.3f} kg"
-        )
-        print(f"Structural Mass Ratio: {self.hybrid_motor.structural_mass_ratio:.3f}")
-        avg = self.hybrid_motor.exhaust_velocity.average(*self.hybrid_motor.burn_time)
-        print(f"Average Propellant Exhaust Velocity: {avg:.3f} m/s")
-        print(f"Average Thrust: {self.hybrid_motor.average_thrust:.3f} N")
-        print(
-            f"Maximum Thrust: {self.hybrid_motor.max_thrust} N at "
-            f"{self.hybrid_motor.max_thrust_time} s after ignition."
-        )
-        print(f"Total Impulse: {self.hybrid_motor.total_impulse:.3f} Ns\n")
-
     def all(self):
         """Prints out all data available about the HybridMotor.
 

rocketpy/prints/liquid_motor_prints.py

@@ -1,4 +1,7 @@
-class _LiquidMotorPrints:
+from .motor_prints import _MotorPrints
+
+
+class _LiquidMotorPrints(_MotorPrints):
     """Class that holds prints methods for LiquidMotor class.
 
     Attributes
@@ -23,6 +26,7 @@ def __init__(
         -------
         None
         """
+        super().__init__(liquid_motor)
         self.liquid_motor = liquid_motor
 
     def nozzle_details(self):
@@ -35,28 +39,6 @@ def nozzle_details(self):
         print("Nozzle Details")
         print("Nozzle Radius: " + str(self.liquid_motor.nozzle_radius) + " m\n")
 
-    def motor_details(self):
-        """Prints out all data available about the motor.
-
-        Returns
-        -------
-        None
-        """
-        print("Motor Details")
-        print(f"Total Burning Time: {self.liquid_motor.burn_duration} s")
-        print(
-            f"Total Propellant Mass: {self.liquid_motor.propellant_initial_mass:.3f} kg"
-        )
-        print(f"Structural Mass Ratio: {self.liquid_motor.structural_mass_ratio:.3f}")
-        avg = self.liquid_motor.exhaust_velocity.average(*self.liquid_motor.burn_time)
-        print(f"Average Propellant Exhaust Velocity: {avg:.3f} m/s")
-        print(f"Average Thrust: {self.liquid_motor.average_thrust:.3f} N")
-        print(
-            f"Maximum Thrust: {self.liquid_motor.max_thrust} N at "
-            f"{self.liquid_motor.max_thrust_time} s after ignition."
-        )
-        print(f"Total Impulse: {self.liquid_motor.total_impulse:.3f} Ns\n")
-
     def all(self):
         """Prints out all data available about the LiquidMotor.