rocketpy 1.6.2__tar.gz → 1.7.0__tar.gz

{rocketpy-1.6.2/rocketpy.egg-info → rocketpy-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rocketpy
-Version: 1.6.2
+Version: 1.7.0
 Summary: Advanced 6-DOF trajectory simulation for High-Power Rocketry.
 Author-email: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
 Project-URL: homepage, https://rocketpy.org/
@@ -230,7 +230,7 @@ A sample Motor object can be created by the following code:
 
 ```python
 Pro75M1670 = SolidMotor(
-    thrust_source="data/motors/Cesaroni_M1670.eng",
+    thrust_source="data/motors/cesaroni/Cesaroni_M1670.eng",
     dry_mass=1.815,
     dry_inertia=(0.125, 0.125, 0.002),
     center_of_dry_mass_position=0.317,
@@ -263,8 +263,8 @@ calisto = Rocket(
     radius=0.0635,
     mass=14.426,  # without motor
     inertia=(6.321, 6.321, 0.034),
-    power_off_drag="data/calisto/powerOffDragCurve.csv",
-    power_on_drag="data/calisto/powerOnDragCurve.csv",
+    power_off_drag="data/rockets/calisto/powerOffDragCurve.csv",
+    power_on_drag="data/rockets/calisto/powerOnDragCurve.csv",
     center_of_mass_without_motor=0,
     coordinate_system_orientation="tail_to_nose",
 )

{rocketpy-1.6.2 → rocketpy-1.7.0}/README.md

@@ -185,7 +185,7 @@ A sample Motor object can be created by the following code:
 
 ```python
 Pro75M1670 = SolidMotor(
-    thrust_source="data/motors/Cesaroni_M1670.eng",
+    thrust_source="data/motors/cesaroni/Cesaroni_M1670.eng",
     dry_mass=1.815,
     dry_inertia=(0.125, 0.125, 0.002),
     center_of_dry_mass_position=0.317,
@@ -218,8 +218,8 @@ calisto = Rocket(
     radius=0.0635,
     mass=14.426,  # without motor
     inertia=(6.321, 6.321, 0.034),
-    power_off_drag="data/calisto/powerOffDragCurve.csv",
-    power_on_drag="data/calisto/powerOnDragCurve.csv",
+    power_off_drag="data/rockets/calisto/powerOffDragCurve.csv",
+    power_on_drag="data/rockets/calisto/powerOnDragCurve.csv",
     center_of_mass_without_motor=0,
     coordinate_system_orientation="tail_to_nose",
 )

{rocketpy-1.6.2 → rocketpy-1.7.0}/pyproject.toml

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

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/environment/environment.py

@@ -1746,6 +1746,8 @@ class Environment:
         # Read weather file
         if isinstance(file, str):
             data = netCDF4.Dataset(file)
+            if dictionary["time"] not in data.variables.keys():
+                dictionary = self.__weather_model_map.get("ECMWF_v0")
         else:
             data = file
 
@@ -1884,9 +1886,9 @@ class Environment:
             temper,
             wind_u,
             wind_v,
-            wind_speed,
             wind_heading,
             wind_direction,
+            wind_speed,
         )
         # Save atmospheric data
         self.__set_pressure_function(data_array[:, (1, 0)])
@@ -1910,7 +1912,12 @@ class Environment:
         # Compute info data
         self.atmospheric_model_init_date = get_initial_date_from_time_array(time_array)
         self.atmospheric_model_end_date = get_final_date_from_time_array(time_array)
-        self.atmospheric_model_interval = get_interval_date_from_time_array(time_array)
+        if self.atmospheric_model_init_date != self.atmospheric_model_end_date:
+            self.atmospheric_model_interval = get_interval_date_from_time_array(
+                time_array
+            )
+        else:
+            self.atmospheric_model_interval = 0
         self.atmospheric_model_init_lat = lat_list[0]
         self.atmospheric_model_end_lat = lat_list[-1]
         self.atmospheric_model_init_lon = lon_list[0]

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/environment/weather_model_mapping.py

@@ -27,7 +27,7 @@ class WeatherModelMapping:
         "u_wind": "ugrdprs",
         "v_wind": "vgrdprs",
     }
-    ECMWF = {
+    ECMWF_v0 = {
         "time": "time",
         "latitude": "latitude",
         "longitude": "longitude",
@@ -39,6 +39,18 @@ class WeatherModelMapping:
         "u_wind": "u",
         "v_wind": "v",
     }
+    ECMWF = {
+        "time": "valid_time",
+        "latitude": "latitude",
+        "longitude": "longitude",
+        "level": "pressure_level",
+        "temperature": "t",
+        "surface_geopotential_height": None,
+        "geopotential_height": None,
+        "geopotential": "z",
+        "u_wind": "u",
+        "v_wind": "v",
+    }
     NOAA = {
         "time": "time",
         "latitude": "lat",
@@ -108,6 +120,7 @@ class WeatherModelMapping:
         self.all_dictionaries = {
             "GFS": self.GFS,
             "NAM": self.NAM,
+            "ECMWF_v0": self.ECMWF_v0,
             "ECMWF": self.ECMWF,
             "NOAA": self.NOAA,
             "RAP": self.RAP,

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/mathutils/function.py

@@ -22,6 +22,8 @@ from scipy.interpolate import (
     RBFInterpolator,
 )
 
+from ..plots.plot_helpers import show_or_save_plot
+
 # Numpy 1.x compatibility,
 # TODO: remove these lines when all dependencies support numpy>=2.0.0
 if np.lib.NumpyVersion(np.__version__) >= "2.0.0b1":
@@ -1378,7 +1380,7 @@ class Function:  # pylint: disable=too-many-public-methods
         )
 
     # Define all presentation methods
-    def __call__(self, *args):
+    def __call__(self, *args, filename=None):
         """Plot the Function if no argument is given. If an
         argument is given, return the value of the function at the desired
         point.
@@ -1392,13 +1394,18 @@ class Function:  # pylint: disable=too-many-public-methods
             evaluated at all points in the list and a list of floats will be
             returned. If the function is N-D, N arguments must be given, each
             one being an scalar or list.
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
         Returns
         -------
         ans : None, scalar, list
         """
         if len(args) == 0:
-            return self.plot()
+            return self.plot(filename=filename)
         else:
             return self.get_value(*args)
 
@@ -1459,8 +1466,11 @@ class Function:  # pylint: disable=too-many-public-methods
         Function.plot_2d if Function is 2-Dimensional and forward arguments
         and key-word arguments."""
         if isinstance(self, list):
+            # Extract filename from kwargs
+            filename = kwargs.get("filename", None)
+
             # Compare multiple plots
-            Function.compare_plots(self)
+            Function.compare_plots(self, filename)
         else:
             if self.__dom_dim__ == 1:
                 self.plot_1d(*args, **kwargs)
@@ -1488,6 +1498,8 @@ class Function:  # pylint: disable=too-many-public-methods
         force_points=False,
         return_object=False,
         equal_axis=False,
+        *,
+        filename=None,
     ):
         """Plot 1-Dimensional Function, from a lower limit to an upper limit,
         by sampling the Function several times in the interval. The title of
@@ -1518,6 +1530,11 @@ class Function:  # pylint: disable=too-many-public-methods
             Setting force_points to True will plot all points, as a scatter, in
             which the Function was evaluated in the dataset. Default value is
             False.
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
         Returns
         -------
@@ -1558,7 +1575,7 @@ class Function:  # pylint: disable=too-many-public-methods
         plt.title(self.title)
         plt.xlabel(self.__inputs__[0].title())
         plt.ylabel(self.__outputs__[0].title())
-        plt.show()
+        show_or_save_plot(filename)
         if return_object:
             return fig, ax
 
@@ -1581,6 +1598,8 @@ class Function:  # pylint: disable=too-many-public-methods
         disp_type="surface",
         alpha=0.6,
         cmap="viridis",
+        *,
+        filename=None,
     ):
         """Plot 2-Dimensional Function, from a lower limit to an upper limit,
         by sampling the Function several times in the interval. The title of
@@ -1620,6 +1639,11 @@ class Function:  # pylint: disable=too-many-public-methods
         cmap : string, optional
             Colormap of plotted graph, which can be any of the color maps
             available in matplotlib. Default value is viridis.
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
         Returns
         -------
@@ -1692,7 +1716,7 @@ class Function:  # pylint: disable=too-many-public-methods
         axes.set_xlabel(self.__inputs__[0].title())
         axes.set_ylabel(self.__inputs__[1].title())
         axes.set_zlabel(self.__outputs__[0].title())
-        plt.show()
+        show_or_save_plot(filename)
 
     @staticmethod
     def compare_plots(  # pylint: disable=too-many-statements
@@ -1707,6 +1731,8 @@ class Function:  # pylint: disable=too-many-public-methods
         force_points=False,
         return_object=False,
         show=True,
+        *,
+        filename=None,
     ):
         """Plots N 1-Dimensional Functions in the same plot, from a lower
         limit to an upper limit, by sampling the Functions several times in
@@ -1751,6 +1777,11 @@ class Function:  # pylint: disable=too-many-public-methods
             False.
         show : bool, optional
             If True, shows the plot. Default value is True.
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
         Returns
         -------
@@ -1826,7 +1857,7 @@ class Function:  # pylint: disable=too-many-public-methods
         plt.ylabel(ylabel)
 
         if show:
-            plt.show()
+            show_or_save_plot(filename)
 
         if return_object:
             return fig, ax

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/motors/hybrid_motor.py

@@ -601,16 +601,19 @@ class HybridMotor(Motor):
         )
         reset_funcified_methods(self)
 
-    def draw(self):
-        """Draws a representation of the HybridMotor."""
-        self.plots.draw()
-
-    def info(self):
-        """Prints out basic data about the Motor."""
-        self.prints.all()
-        self.plots.thrust()
-
-    def all_info(self):
-        """Prints out all data and graphs available about the Motor."""
-        self.prints.all()
-        self.plots.all()
+    def draw(self, *, filename=None):
+        """Draws a representation of the HybridMotor.
+
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
+        Returns
+        -------
+        None
+        """
+        self.plots.draw(filename=filename)

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/motors/liquid_motor.py

@@ -463,21 +463,19 @@ class LiquidMotor(Motor):
         self.positioned_tanks.append({"tank": tank, "position": position})
         reset_funcified_methods(self)
 
-    def draw(self):
-        """Draw a representation of the LiquidMotor."""
-        self.plots.draw()
+    def draw(self, *, filename=None):
+        """Draw a representation of the LiquidMotor.
 
-    def info(self):
-        """Prints out basic data about the Motor."""
-        self.prints.all()
-        self.plots.thrust()
-
-    def all_info(self):
-        """Prints out all data and graphs available about the Motor.
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
-        Return
-        ------
+        Returns
+        -------
         None
         """
-        self.prints.all()
-        self.plots.all()
+        self.plots.draw(filename=filename)

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/motors/motor.py

@@ -1083,15 +1083,26 @@ class Motor(ABC):
             # Write last line
             file.write(f"{self.thrust.source[-1, 0]:.4f} {0:.3f}\n")
 
-    def info(self):
+    def info(self, *, filename=None):
         """Prints out a summary of the data and graphs available about the
         Motor.
+
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
+        Returns
+        -------
+        None
         """
         # Print motor details
         self.prints.all()
-        self.plots.thrust()
+        self.plots.thrust(filename=filename)
 
-    @abstractmethod
     def all_info(self):
         """Prints out all data and graphs available about the Motor."""
         self.prints.all()

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/motors/solid_motor.py

@@ -727,16 +727,19 @@ class SolidMotor(Motor):
     def propellant_I_23(self):
         return 0
 
-    def draw(self):
-        """Draw a representation of the SolidMotor."""
-        self.plots.draw()
-
-    def info(self):
-        """Prints out basic data about the SolidMotor."""
-        self.prints.all()
-        self.plots.thrust()
-
-    def all_info(self):
-        """Prints out all data and graphs available about the SolidMotor."""
-        self.prints.all()
-        self.plots.all()
+    def draw(self, *, filename=None):
+        """Draw a representation of the SolidMotor.
+
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
+        Returns
+        -------
+        None
+        """
+        self.plots.draw(filename=filename)

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/motors/tank.py

@@ -476,9 +476,22 @@ class Tank(ABC):
             elif (height < bottom_tolerance).any():
                 underfill_height_exception(name, height)
 
-    def draw(self):
-        """Draws the tank geometry."""
-        self.plots.draw()
+    def draw(self, *, filename=None):
+        """Draws the tank geometry.
+
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
+        Returns
+        -------
+        None
+        """
+        self.plots.draw(filename=filename)
 
 
 class MassFlowRateBasedTank(Tank):

{rocketpy-1.6.2 → rocketpy-1.7.0}/rocketpy/plots/aero_surface_plots.py

@@ -4,6 +4,8 @@ import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib.patches import Ellipse
 
+from .plot_helpers import show_or_save_plot
+
 
 class _AeroSurfacePlots(ABC):
     """Abstract class that contains all aero surface plots."""
@@ -23,7 +25,7 @@ class _AeroSurfacePlots(ABC):
         self.aero_surface = aero_surface
 
     @abstractmethod
-    def draw(self):
+    def draw(self, *, filename=None):
         pass
 
     def lift(self):
@@ -52,10 +54,18 @@ class _NoseConePlots(_AeroSurfacePlots):
     """Class that contains all nosecone plots. This class inherits from the
     _AeroSurfacePlots class."""
 
-    def draw(self):
+    def draw(self, *, filename=None):
         """Draw the nosecone shape along with some important information,
         including the center line and the center of pressure position.
 
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
         Returns
         -------
         None
@@ -122,8 +132,7 @@ class _NoseConePlots(_AeroSurfacePlots):
         ax.set_ylabel("Radius")
         ax.set_title(self.aero_surface.kind + " Nose Cone")
         ax.legend(bbox_to_anchor=(1, -0.2))
-
-        plt.show()
+        show_or_save_plot(filename)
 
 
 class _FinsPlots(_AeroSurfacePlots):
@@ -131,7 +140,7 @@ class _FinsPlots(_AeroSurfacePlots):
     _AeroSurfacePlots class."""
 
     @abstractmethod
-    def draw(self):
+    def draw(self, *, filename=None):
         pass
 
     def airfoil(self):
@@ -192,10 +201,18 @@ class _TrapezoidalFinsPlots(_FinsPlots):
     """Class that contains all trapezoidal fin plots."""
 
     # pylint: disable=too-many-statements
-    def draw(self):
+    def draw(self, *, filename=None):
         """Draw the fin shape along with some important information, including
         the center line, the quarter line and the center of pressure position.
 
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
         Returns
         -------
         None
@@ -306,17 +323,25 @@ class _TrapezoidalFinsPlots(_FinsPlots):
         ax.legend(bbox_to_anchor=(1.05, 1.0), loc="upper left")
 
         plt.tight_layout()
-        plt.show()
+        show_or_save_plot(filename)
 
 
 class _EllipticalFinsPlots(_FinsPlots):
     """Class that contains all elliptical fin plots."""
 
     # pylint: disable=too-many-statements
-    def draw(self):
+    def draw(self, *, filename=None):
         """Draw the fin shape along with some important information.
         These being: the center line and the center of pressure position.
 
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
+
         Returns
         -------
         None
@@ -377,16 +402,24 @@ class _EllipticalFinsPlots(_FinsPlots):
         ax.legend(bbox_to_anchor=(1.05, 1.0), loc="upper left")
 
         plt.tight_layout()
-        plt.show()
+        show_or_save_plot(filename)
 
 
 class _FreeFormFinsPlots(_FinsPlots):
     """Class that contains all free form fin plots."""
 
     # pylint: disable=too-many-statements
-    def draw(self):
-        """Draw the fin shape along with some important information, including
-        the center line, the quarter line and the center of pressure position.
+    def draw(self, *, filename=None):
+        """Draw the fin shape along with some important information.
+        These being: the center line and the center of pressure position.
+
+        Parameters
+        ----------
+        filename : str | None, optional
+            The path the plot should be saved to. By default None, in which case
+            the plot will be shown instead of saved. Supported file endings are:
+            eps, jpg, jpeg, pdf, pgf, png, ps, raw, rgba, svg, svgz, tif, tiff
+            and webp (these are the formats supported by matplotlib).
 
         Returns
         -------
@@ -444,13 +477,13 @@ class _FreeFormFinsPlots(_FinsPlots):
         ax.legend(bbox_to_anchor=(1.05, 1.0), loc="upper left")
 
         plt.tight_layout()
-        plt.show()
+        show_or_save_plot(filename)
 
 
 class _TailPlots(_AeroSurfacePlots):
     """Class that contains all tail plots."""
 
-    def draw(self):
+    def draw(self, *, filename=None):
         # This will de done in the future
         pass
 
@@ -465,7 +498,7 @@ class _AirBrakesPlots(_AeroSurfacePlots):
         else:
             return self.aero_surface.drag_coefficient.plot()
 
-    def draw(self):
+    def draw(self, *, filename=None):
         raise NotImplementedError
 
     def all(self):
@@ -481,12 +514,12 @@ class _AirBrakesPlots(_AeroSurfacePlots):
 class _GenericSurfacePlots(_AeroSurfacePlots):
     """Class that contains all generic surface plots."""
 
-    def draw(self):
+    def draw(self, *, filename=None):
         pass
 
 
 class _LinearGenericSurfacePlots(_AeroSurfacePlots):
     """Class that contains all linear generic surface plots."""
 
-    def draw(self):
+    def draw(self, *, filename=None):
         pass