MNT: Allow for encoding customization of MonteCarlo.

Author: phmbressan

docs/notebooks/monte_carlo_analysis/monte_carlo_analysis_outputs/monte_carlo_class_example.inputs.txt

@@ -1,20 +1,21 @@
 """Defines a custom JSON encoder for RocketPy objects."""
 
-import base64
 import json
 from datetime import datetime
 from importlib import import_module
 
-import dill
 import numpy as np
 
+from rocketpy.mathutils.function import Function
+
 
 class RocketPyEncoder(json.JSONEncoder):
     """Custom JSON encoder for RocketPy objects. It defines how to encode
     different types of objects to a JSON supported format."""
 
     def __init__(self, *args, **kwargs):
         self.include_outputs = kwargs.pop("include_outputs", False)
+        self.include_function_data = kwargs.pop("include_function_data", True)
         super().__init__(*args, **kwargs)
 
     def default(self, o):
@@ -43,6 +44,13 @@ def default(self, o):
             return [o.year, o.month, o.day, o.hour]
         elif hasattr(o, "__iter__") and not isinstance(o, str):
             return list(o)
+        elif isinstance(o, Function):
+            if not self.include_function_data:
+                return str(o)
+            else:
+                encoding = o.to_dict(self.include_outputs)
+                encoding["signature"] = get_class_signature(o)
+                return encoding
         elif hasattr(o, "to_dict"):
             encoding = o.to_dict(self.include_outputs)
             encoding = remove_circular_references(encoding)
@@ -155,39 +163,3 @@ def remove_circular_references(obj_dict):
     obj_dict.pop("plots", None)
 
     return obj_dict
-
-
-def to_hex_encode(obj, encoder=base64.b85encode):
-    """Converts an object to hex representation using dill.
-
-    Parameters
-    ----------
-    obj : object
-        Object to be converted to hex.
-    encoder : callable, optional
-        Function to encode the bytes. Default is base64.b85encode.
-
-    Returns
-    -------
-    bytes
-        Object converted to bytes.
-    """
-    return encoder(dill.dumps(obj)).hex()
-
-
-def from_hex_decode(obj_bytes, decoder=base64.b85decode):
-    """Converts an object from hex representation using dill.
-
-    Parameters
-    ----------
-    obj_bytes : str
-        Hex string to be converted to object.
-    decoder : callable, optional
-        Function to decode the bytes. Default is base64.b85decode.
-
-    Returns
-    -------
-    object
-        Object converted from bytes.
-    """
-    return dill.loads(decoder(bytes.fromhex(obj_bytes)))

docs/notebooks/monte_carlo_analysis/monte_carlo_analysis_outputs/monte_carlo_class_example.kml

@@ -22,9 +22,9 @@
     RBFInterpolator,
 )
 
-from ..plots.plot_helpers import show_or_save_plot
+from rocketpy.tools import from_hex_decode, to_hex_encode
 
-from rocketpy._encoders import from_hex_decode, to_hex_encode
+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

docs/notebooks/monte_carlo_analysis/monte_carlo_analysis_outputs/monte_carlo_class_example.outputs.txt

@@ -2,7 +2,7 @@
 
 import numpy as np
 
-from rocketpy._encoders import from_hex_decode, to_hex_encode
+from rocketpy.tools import from_hex_decode, to_hex_encode
 
 from ..mathutils.function import Function
 from ..prints.parachute_prints import _ParachutePrints

docs/notebooks/monte_carlo_analysis/monte_carlo_class_usage.ipynb

@@ -173,7 +173,7 @@ def __init__(
 
     # pylint: disable=consider-using-with
     def simulate(
-        self, number_of_simulations, append=False
+        self, number_of_simulations, append=False, **kwargs
     ):  # pylint: disable=too-many-statements
         """
         Runs the Monte Carlo simulation and saves all data.
@@ -185,6 +185,17 @@ def simulate(
         append : bool, optional
             If True, the results will be appended to the existing files. If
             False, the files will be overwritten. Default is False.
+        kwargs : dict
+            Custom arguments for simulation export of the ``inputs`` file. Options
+            are:
+
+                * ``include_outputs``: whether to also include outputs data of the
+                  simulation. Default is ``False``.
+
+                * ``include_function_data``: whether to include ``rocketpy.Function``
+                  results into the export. Default is ``True``.
+
+            See ``rocketpy._encoders.RocketPyEncoder`` for more information.
 
         Returns
         -------
@@ -204,6 +215,7 @@ def simulate(
         overwritten. Make sure to save the files with the results before
         running the simulation again with `append=False`.
         """
+        self._export_config = kwargs
         # Create data files for inputs, outputs and error logging
         open_mode = "a" if append else "w"
         input_file = open(self._input_file, open_mode, encoding="utf-8")
@@ -224,11 +236,21 @@ def simulate(
                 self.__run_single_simulation(input_file, output_file)
         except KeyboardInterrupt:
             print("Keyboard Interrupt, files saved.")
-            error_file.write(json.dumps(self._inputs_dict, cls=RocketPyEncoder) + "\n")
+            error_file.write(
+                json.dumps(
+                    self._inputs_dict, cls=RocketPyEncoder, **self._export_config
+                )
+                + "\n"
+            )
             self.__close_files(input_file, output_file, error_file)
         except Exception as error:
             print(f"Error on iteration {self.__iteration_count}: {error}")
-            error_file.write(json.dumps(self._inputs_dict, cls=RocketPyEncoder) + "\n")
+            error_file.write(
+                json.dumps(
+                    self._inputs_dict, cls=RocketPyEncoder, **self._export_config
+                )
+                + "\n"
+            )
             self.__close_files(input_file, output_file, error_file)
             raise error
         finally:
@@ -393,8 +415,12 @@ def __export_flight_data(
                     ) from e
             results = results | additional_exports
 
-        input_file.write(json.dumps(inputs_dict, cls=RocketPyEncoder) + "\n")
-        output_file.write(json.dumps(results, cls=RocketPyEncoder) + "\n")
+        input_file.write(
+            json.dumps(inputs_dict, cls=RocketPyEncoder, **self._export_config) + "\n"
+        )
+        output_file.write(
+            json.dumps(results, cls=RocketPyEncoder, **self._export_config) + "\n"
+        )
 
     def __check_export_list(self, export_list):
         """

rocketpy/_encoders.py

@@ -6,6 +6,7 @@
 between minor versions if necessary, although this will be always avoided.
 """
 
+import base64
 import functools
 import importlib
 import importlib.metadata
@@ -15,6 +16,7 @@
 import time
 from bisect import bisect_left
 
+import dill
 import matplotlib.pyplot as plt
 import numpy as np
 import pytz
@@ -1167,6 +1169,42 @@ def get_matplotlib_supported_file_endings():
     return filetypes
 
 
+def to_hex_encode(obj, encoder=base64.b85encode):
+    """Converts an object to hex representation using dill.
+
+    Parameters
+    ----------
+    obj : object
+        Object to be converted to hex.
+    encoder : callable, optional
+        Function to encode the bytes. Default is base64.b85encode.
+
+    Returns
+    -------
+    bytes
+        Object converted to bytes.
+    """
+    return encoder(dill.dumps(obj)).hex()
+
+
+def from_hex_decode(obj_bytes, decoder=base64.b85decode):
+    """Converts an object from hex representation using dill.
+
+    Parameters
+    ----------
+    obj_bytes : str
+        Hex string to be converted to object.
+    decoder : callable, optional
+        Function to decode the bytes. Default is base64.b85decode.
+
+    Returns
+    -------
+    object
+        Object converted from bytes.
+    """
+    return dill.loads(decoder(bytes.fromhex(obj_bytes)))
+
+
 if __name__ == "__main__":
     import doctest
 

rocketpy/mathutils/function.py

@@ -8,6 +8,7 @@
     LevelBasedTank,
     MassBasedTank,
     MassFlowRateBasedTank,
+    SphericalTank,
     TankGeometry,
     UllageBasedTank,
 )
@@ -430,9 +431,7 @@ def oxidizer_tank(oxidizer_fluid, oxidizer_pressurant, propellant_tank_geometry)
 
 
 @pytest.fixture
-def spherical_oxidizer_tank(
-    oxidizer_fluid, oxidizer_pressurant, spherical_oxidizer_geometry
-):
+def spherical_oxidizer_tank(oxidizer_fluid, oxidizer_pressurant):
     """An example of a oxidizer spherical tank.
 
     Parameters
@@ -447,12 +446,11 @@ def spherical_oxidizer_tank(
     -------
     rocketpy.LevelBasedTank
     """
-    geometry = SphericalTank(0.051)
     liquid_level = Function(lambda t: 0.1 * np.exp(-t / 2) - 0.05)
     oxidizer_tank = LevelBasedTank(
         name="Lox Tank",
         flux_time=10,
-        geometry=spherical_oxidizer_geometry,
+        geometry=SphericalTank(0.0501),
         liquid=oxidizer_fluid,
         gas=oxidizer_pressurant,
         liquid_height=liquid_level,