Skip to content

ENH: Add Monte Carlo outputs export to CSV/JSON (#242) #912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GMinoruy wants to merge 10 commits into
base: develop
Choose a base branch
from
+110 −0
Open

ENH: Add Monte Carlo outputs export to CSV/JSON (#242) #912

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e51b221
ENH: trying to add Monte Carlo output to csv and json see issue #242
GMinoruy Dec 4, 2025
fe7c69e
ENH: corrects errors identified during testing
GMinoruy Dec 6, 2025
1c1c77a
ENH: adds example on how to use the export_results function
GMinoruy Dec 6, 2025
ee4bab5
ENH: adds visual feedback when exporting in csv and json
GMinoruy Dec 6, 2025
d0cc223
ENH: adds Docstring to the function
GMinoruy Dec 7, 2025
6503273
ENH: adds unit test of the function export_results
GMinoruy Dec 7, 2025
8eecdc9
Update tests/unit/simulation/test_monte_carlo.py
GMinoruy Apr 21, 2026
a5e77a8
Simplification of f-string usage
GMinoruy Apr 21, 2026
d91ae51
ENH: verifies that files created for tests have proper mock data
GMinoruy Apr 21, 2026
8735ed0
ENH: verifies if the test files actually exists before removing them
GMinoruy Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
ENH: adds Docstring to the function
  • Loading branch information
@GMinoruy @Gui-FernandesBR
GMinoruy authored and Gui-FernandesBR committed Dec 9, 2025
commit d0cc223ee8fe31f5f1f4e31a2d1cd45ec8702a27
14 changes: 14 additions & 0 deletions rocketpy/simulation/monte_carlo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,6 +590,20 @@ def __evaluate_flight_outputs(self, flight, sim_idx):
)

def export_results(self, output_filename, output_format):
"""Converts the default Monte Carlo .txt output to .cvs or .json file
Copy link

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in docstring: ".cvs" should be ".csv"

Suggested change
"""Converts the default Monte Carlo .txt output to .cvs or .json file
"""Converts the default Monte Carlo .txt output to .csv or .json file

Copilot uses AI. Check for mistakes.
depending on the user's choice

Parameters
----------
output_filename : str
Name of the file in which the converted data will be saved
output_format : str
Format of the output file

Returns
-------
None
Comment on lines +593 to +605
Copy link

Copilot AI Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring is missing important details. It should:

  1. Specify that output_filename can be a string or Path object
  2. Document the valid values for output_format ("csv" or "json")
  3. Explain what happens if the output file already exists (will it be overwritten?)
  4. Mention that the method reads from self.filename.outputs.txt
  5. Follow NumPy docstring format with a proper description section before Parameters

Example improvement:

\"\"\"Export Monte Carlo simulation results to CSV or JSON format.

This method reads simulation output data from the `.outputs.txt` file
and converts it to either CSV or JSON format based on user selection.

Parameters
----------
output_filename : str or Path
    Path and name of the output file (without extension). The appropriate
    extension (.csv or .json) will be added automatically.
output_format : str
    Format of the output file. Must be either "csv" or "json" (case-insensitive).

Returns
-------
None

Raises
------
FileNotFoundError
    If the `.outputs.txt` file does not exist.
ValueError
    If `output_format` is not "csv" or "json".
\"\"\"
Suggested change
"""Converts the default Monte Carlo .txt output to .cvs or .json file
depending on the user's choice
Parameters
----------
output_filename : str
Name of the file in which the converted data will be saved
output_format : str
Format of the output file
Returns
-------
None
"""Export Monte Carlo simulation results to CSV or JSON format.
This method reads simulation output data from the `.outputs.txt` file
(specifically, from `self.filename.outputs.txt`) and converts it to either
CSV or JSON format based on user selection. The output file will be
overwritten if it already exists.
Parameters
----------
output_filename : str or Path
Path and name of the output file (without extension). The appropriate
extension (.csv or .json) will be added automatically.
output_format : str
Format of the output file. Must be either "csv" or "json"
(case-insensitive).
Returns
-------
None
Raises
------
FileNotFoundError
If the `.outputs.txt` file does not exist.
ValueError
If `output_format` is not "csv" or "json".
Examples
--------
>>> mc.export_results("results", "csv")
>>> mc.export_results(Path("results_folder/results"), "json")

Copilot uses AI. Check for mistakes.
"""
txt_data = []
with open(f"{self.filename}.outputs.txt", "r", encoding="utf-8") as f:
for line in f:
Expand Down