Skip to content
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.

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

ENH: Display more information in MonteCarlo prints and plots #760

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Attention: The newest changes should be on top -->
-

### Changed

- ENH: Display more information in MonteCarlo prints and plots [#760](https://github.com/RocketPy-Team/RocketPy/pull/760)
-

### Fixed
Expand Down
18 changes: 13 additions & 5 deletions rocketpy/plots/monte_carlo_plots.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,18 @@ def all(self, keys=None):
)
else:
raise ValueError("The 'keys' argument must be a string, list, or tuple.")

for key in keys:
plt.figure()
plt.hist(self.monte_carlo.results[key])
plt.title(f"Histogram of {key}")
plt.ylabel("Number of Occurrences")
fig, (ax1, ax2) = plt.subplots(2, 1, height_ratios=[1, 3], figsize=(8, 8))

# Plot boxplot
ax1.boxplot(self.monte_carlo.results[key], vert=False)
ax1.set_xlabel(key)
ax1.set_title(f"Box Plot of {key}")

# Plot histogram
ax2.hist(self.monte_carlo.results[key])
ax2.set_title(f"Histogram of {key}")
ax2.set_ylabel("Number of Occurrences")

plt.tight_layout()
plt.show()
Comment on lines 176 to 190
Copy link
Member

Choose a reason for hiding this comment

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

@Lucas-Prates should we really plot the 3 plot altogether? Perhaps letting the user activate/deactivate some of them if needed?

17 changes: 13 additions & 4 deletions rocketpy/prints/monte_carlo_prints.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import numpy as np


class _MonteCarloPrints:
"""Class to print the monte carlo analysis results."""

Expand All @@ -21,10 +24,16 @@ def all(self):
print("Data Source: ", self.monte_carlo.filename)
print("Number of simulations: ", self.monte_carlo.num_of_loaded_sims)
print("Results: \n")
print(f"{'Parameter':>25} {'Mean':>15} {'Std. Dev.':>15}")
print("-" * 60)
print(
f"{'Parameter':>25} {'Mean':>15} {'Median':>15} {'Std. Dev.':>15} {'95% PI Lower':>15} {'95% PI Upper':>15}"
)
print("-" * 110)
for key, value in self.monte_carlo.processed_results.items():
try:
print(f"{key:>25} {value[0]:>15.3f} {value[1]:>15.3f}")
print(
f"{key:>25} {value[0]:>15.3f} {value[1]:>15.3f} {value[2]:>15.3f} {value[3]:>15.3f} {value[4]:>15.3f}"
)
except TypeError:
print(f"{key:>25} {str(value[0]):>15} {str(value[1]):>15}")
print(
f"{key:>25} {str(value[0]):>15} {str(value[1]):>15} {'N/A':>15} {'N/A':>15}"
)
10 changes: 9 additions & 1 deletion rocketpy/simulation/monte_carlo.py
Original file line number Diff line number Diff line change
Expand Up @@ -723,8 +723,16 @@ def set_processed_results(self):
mean = np.mean(values)
stdev = np.std(values)
self.processed_results[result] = (mean, stdev)
pi_low = np.quantile(values, 0.025)
pi_high = np.quantile(values, 0.975)
median = np.median(values)
except TypeError:
self.processed_results[result] = (None, None)
mean = None
stdev = None
pi_low = None
pi_high = None
median = None
self.processed_results[result] = (mean, median, stdev, pi_low, pi_high)

# Import methods

Expand Down
Loading