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

DOC: Monte carlo documentation updates #607

Merged
merged 69 commits into from
Jun 1, 2024

Conversation

Gui-FernandesBR
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR commented May 23, 2024

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Tests for the changes have been added (not needed)
  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest tests -m slow --runslow) have passed locally
  • CHANGELOG.md has been updated (if relevant)

Current behavior

The MonteCarlo class is ready to be deployed but there is still a room to improve its documentation and examples.

New behavior

See the commit history one by one.
To keep in mind:

  • Don't "over document" the code, only leave # this is a comment when it is really necessary or helps to organize.
  • All the class and methods docstrings were reviewed
  • Some TODOs were added to the code, as I saw some improvements opportunities but didn't want to fix them in this same PR.
  • I created a new .rst totally dedicated to explain how to use the Stochastic classes. I think this will make lives easier when reading the monte carlo example notebook.
  • Some stuff don't even make sense in the code (e.g. varying the number of grains of a motor???). But we can remove/improve it in the next minor release.

Important: There is something broken with the Environment class when integrating with NOAAs data server. I cannot not solve it immediately. If you want to build the documentation locally, please comment the examples that use GFS or GEFS environment model.

Breaking change

  • No

Additional information

Still needs to accomplish:

  • Finish the StochasticModel review
  • Finish all other Stochastic classes reviews.
  • Double check the jupyter notebooks

Make no mistake, updating docstrings is not an easy task. I think we should release the next version using the "as-is" state, and keep improving the documentation based on users feedbacks.

Copy link

codecov bot commented May 23, 2024

Codecov Report

Attention: Patch coverage is 64.81481% with 19 lines in your changes are missing coverage. Please review.

Project coverage is 73.60%. Comparing base (eeb4df8) to head (cd1def5).
Report is 1 commits behind head on develop.

Files Patch % Lines
rocketpy/simulation/monte_carlo.py 13.33% 13 Missing ⚠️
rocketpy/stochastic/stochastic_model.py 87.50% 4 Missing ⚠️
rocketpy/plots/monte_carlo_plots.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #607      +/-   ##
===========================================
+ Coverage    73.58%   73.60%   +0.01%     
===========================================
  Files           70       70              
  Lines        10313    10289      -24     
===========================================
- Hits          7589     7573      -16     
+ Misses        2724     2716       -8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone May 25, 2024
@Gui-FernandesBR Gui-FernandesBR added Docs Docs and examples related Monte Carlo Monte Carlo and related contents labels May 25, 2024
@Gui-FernandesBR Gui-FernandesBR self-assigned this May 25, 2024
@Gui-FernandesBR Gui-FernandesBR marked this pull request as ready for review May 25, 2024 22:03
@Gui-FernandesBR Gui-FernandesBR requested a review from a team as a code owner May 25, 2024 22:03
@Gui-FernandesBR
Copy link
Member Author

Here you can see a preview:

image
image
image
image

@Gui-FernandesBR Gui-FernandesBR force-pushed the doc/monte-carlo-documentation-updates branch from 0ae1c37 to 1e561fe Compare May 30, 2024 15:30
Copy link
Collaborator

@phmbressan phmbressan left a comment

Choose a reason for hiding this comment

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

Outstanding work @Gui-FernandesBR! I read through everything and most of the comments I had were similar to the ones made by Stano.

Sorry if my review seems lacking in comments given the size of the PR, but I believe the work here is rather solid, specially the page on Stochastic objects.

@Gui-FernandesBR
Copy link
Member Author

@phmbressan @MateusStano the last commit cf24129 polished a few TODO messages (they are less "aggressive" now).

I think it is ready to be merged. Can you approve please?

@Gui-FernandesBR Gui-FernandesBR merged commit 224e255 into develop Jun 1, 2024
9 of 10 checks passed
@Gui-FernandesBR Gui-FernandesBR deleted the doc/monte-carlo-documentation-updates branch June 1, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Monte Carlo Monte Carlo and related contents
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

4 participants