Merge branch 'develop' into enh/improve-parachute-geometric-parametrization

Author: ArthurJWH

.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

@@ -31,11 +31,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Attention: The newest changes should be on top -->
 
 ### Added
+
+-  ENH: Add the Coriolis Force to the Flight class [#799](https://github.com/RocketPy-Team/RocketPy/pull/799)
+
+### Changed
+
+- 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
+
+
+## [v1.10.0] - 2025-05-16
+
+### 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)
+- ENH: Environment object from EnvironmentAnalysis [#813](https://github.com/RocketPy-Team/RocketPy/pull/813)
 
 ### Changed
 
@@ -48,7 +64,7 @@ Attention: The newest changes should be on top -->
 - BUG: Wrong Phi Initialization For nose_to_tail Rockets [#809](https://github.com/RocketPy-Team/RocketPy/pull/809)
 - BUG: Fix StochasticFlight time_overshoot None bug [#805](https://github.com/RocketPy-Team/RocketPy/pull/805)
 
-## v1.9.0 - 2025-03-24
+## [v1.9.0] - 2025-03-24
 
 ### Added
 

docs/conf.py

@@ -27,7 +27,7 @@
 author = "RocketPy Team"
 
 # The full version, including alpha/beta/rc tags
-release = "1.9.0"
+release = "1.10.0"
 
 
 # -- General configuration ---------------------------------------------------

docs/user/installation.rst

@@ -19,7 +19,7 @@ If you want to choose a specific version to guarantee compatibility, you may ins
 
 .. code-block:: shell
 
-    pip install rocketpy==1.9.0
+    pip install rocketpy==1.10.0
 
 
 Optional Installation Method: ``conda``

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rocketpy"
-version = "1.9.0"
+version = "1.10.0"
 description="Advanced 6-DOF trajectory simulation for High-Power Rocketry."
 dynamic = ["dependencies"]
 readme = "README.md"

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/environment/environment_analysis.py

@@ -2885,3 +2885,79 @@ def save(self, filename="env_analysis_dict"):
         file.write(encoded_class)
         file.close()
         print("Your Environment Analysis file was saved, check it out: " + filename)
+
+    def create_environment_object(
+        self, gravity=None, date=None, datum="SIRGAS2000", max_expected_height=80000.0
+    ):
+        """Creates an Environment object with the data from the Environment Analysis instance.
+        It uses the average values from the data.
+
+        Parameters
+        ----------
+        gravity : int, float, callable, string, array, optional
+            Surface gravitational acceleration. Positive values point the
+            acceleration down. If None, the Somigliana formula is used.
+            See :meth:`Environment.set_gravity_model` for more information.
+        date : list or tuple, optional
+            List or tuple of length 4, stating (year, month, day, hour) in the
+            time zone used in the Environment Analysis instance.
+            Alternatively, can be a ``datetime`` object specifying launch
+            date and time. The dates are stored as follows:
+
+            - :attr:`Environment.local_date`: Local time of launch in
+              the time zone specified in the Environment Analysis instance.
+
+            - :attr:`Environment.datetime_date`: UTC time of launch.
+
+            Default is None.
+            See :meth:`Environment.set_date` for more information.
+        datum : string, optional
+            The desired reference ellipsoidal model, the following options are
+            available: "SAD69", "WGS84", "NAD83", and "SIRGAS2000". The default
+            is "SIRGAS2000".
+        max_expected_height : float, optional
+            Maximum altitude in meters to keep weather data. The altitude must
+            be above sea level (ASL). Especially useful for visualization. Can
+            be altered as desired by running ``max_expected_height = number``.
+        """
+        elevation_si = convert_units(
+            self.converted_elevation, self.unit_system["length"], "m"
+        )
+        altitude_si = convert_units(self.altitude_list, self.unit_system["length"], "m")
+        # Recalculating pressure profile using numpy.percentile
+        pressures = [
+            day_dict[hour]["pressure"](self.altitude_list)
+            for day_dict in self.converted_pressure_level_data.values()
+            for hour in day_dict.keys()
+        ]
+        pressure_profile = np.percentile(pressures, 50, axis=0)
+        pressure_si = convert_units(
+            pressure_profile, self.unit_system["pressure"], "Pa"
+        )
+        temperature_si = convert_units(
+            self.average_temperature_profile, self.unit_system["temperature"], "K"
+        )
+        wind_velocity_x_si = convert_units(
+            self.average_wind_velocity_x_profile, self.unit_system["wind_speed"], "m/s"
+        )
+        wind_velocity_y_si = convert_units(
+            self.average_wind_velocity_y_profile, self.unit_system["wind_speed"], "m/s"
+        )
+        env = Environment(
+            gravity,
+            date,
+            self.latitude,
+            self.longitude,
+            elevation_si,
+            datum,
+            self.preferred_timezone,
+            max_expected_height,
+        )
+        env.set_atmospheric_model(
+            type="custom_atmosphere",
+            pressure=list(zip(altitude_si, pressure_si)),
+            temperature=list(zip(altitude_si, temperature_si)),
+            wind_u=list(zip(altitude_si, wind_velocity_x_si)),
+            wind_v=list(zip(altitude_si, wind_velocity_y_si)),
+        )
+        return env