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/parachute #108
Enh/parachute #108
Conversation
ENH: add utilities.py module to rocketpy. There are several functions that are useful to RocketPy but should not belong to any class in the software. Therefore, a module that keeps those functions may be benefitial to RocketPy.
@FranzYuri, I would suggest you run black to reformat your code:
The second thing is that it may be necessary to add something like |
Can you guys please indicate other functions with that same behavior in the code? |
@Gui-FernandesBR for now I haven't personally identified any function that applies. But I imagine we could use this file in the future to gather functions to help design Rockets/Parachutes/Motors etc. For example functions related to rocket parameter optimizations (ideal mass for a certain motor or something similar). I think the suggestion to create |
Tks for explaning that, @Lucas-KB . If I'm understamdimg this correctly, I have some candidates to be included at utilities.py, let's see:
Those could help to give more "body" to this new .py file, and they could be moved in another PR I guess. Please let me know if these suggestions are good or not. Also, I would recommend creating a simple example usage for these functions. At least for me, it is not easy to visualize how I could use the new capabilities. |
Excellent suggestions @Gui-FernandesBR! I hope you are ok with me creating a new issue regarding your ideas so that we can come back to them in a future PR. The issue is here #111. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks awesome! Just a few details to iron out and then we can merge this PR, which marks a new path for RocketPy functionalities.
Don't need my permission @giovaniceotto ... Thanks for opening the 111, I appreciate it |
Co-authored-by: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
Co-authored-by: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
Co-authored-by: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
Co-authored-by: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
Adding a module utilities to keep usefull functions to RocketPy.
@giovaniceotto I think it is alright now, can you take a look? |
@FranzYuri, my bad, I had reviewed your changes but forgot to approve it! Looks perfect now. Would you do the honors of merging the pull request? |
Pull request type
Please check the type of change your PR introduces:
Pull request checklist
Please check if your PR fulfills the following requirements, depending on the type of PR:
ReadMe, Docs and GitHub maintenance:
Code base maintenance (refactoring, formatting, renaming):
black rocketpy
) has passed locally and any fixes were madepytest --runslow
) have passed locallyCode base additions (for bug fixes / features):
black rocketpy
) has passed locally and any fixes were madepytest --runslow
) have passed locallyWhat is the current behavior?
Currently there is no place to keep functions that are useful but do not belong to any of the 5 core classes in Rocketpy.
One of these functions is the compute_cds_from_drop_test, that calculates the CdS of a parachute from a drop test.
What is the new behavior?
With the module utilities.py, it is possible to save functions like the compute_cds_from_drop_test.
Does this introduce a breaking change?
Other information
Enter text here...